Retrieves the contact with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
Company of the contact |
globally unique identifier |
Optionally required : company_id,company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating contact |
string |
Optionally required : company_id,company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating contact |
company |
Optionally required : company_id,company_code or company must be provided |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating contact |
string | |
| db_title_id |
The title of the contact |
globally unique identifier | |
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| e_login |
Login of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| e_password |
Password in clear text of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| notes |
Notes/Remark field |
string | |
| birthdate |
Birthday date |
date | |
| create_date |
Creation date+time |
date | |
| phone |
Phone number of the contact |
string |
Max length: 50 |
| mobile |
a number of the contact |
string |
Max length: 50 |
|
|
string |
Max length: 250 |
|
| skype |
skype |
string |
Max length: 250 |
| private_phone |
Private phone number of the contact |
string |
Max length: 50 |
| private_mobile |
Private mobile number of the contact |
string |
Max length: 50 |
| private_email |
Private email |
string |
Max length: 250 |
| reference_back_office |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "73f30dad-9c7e-40bd-a82a-1fbf50ce4322",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dfa453e4-39f0-4fc7-9ed8-6b5a8a9cbcec",
"company_code": "sample string 5",
"company": {
"id": "069abe4a-4fd9-4999-b399-a67ef14dcda6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-04T23:25:47.6807071+00:00",
"sales_territory_id": "cd76ab92-b8d8-47d8-9483-4d6b6ae286b5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1b974ba8-4b1b-4e1d-bfab-a3cb51bacbff",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "717a2467-1779-4568-a14d-1fc229764a42",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6efed89f-a0f2-4895-b86b-fd9259d013ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7931498-e4ac-4b2c-aee9-3e264a4adfab",
"db_currency_id": "5bf5e5aa-3442-4cca-8f5d-7013a587c739",
"db_language_id": "55615a28-5469-4280-aefb-38aaf21b3c40",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-04T23:25:47.6807071+00:00"
},
"modified_dateutc": "2026-07-04T23:25:47.6807071+00:00"
},
"marketing_segment_id": "6577ac03-b143-4da8-b136-04c4e544e90d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0477f789-dd00-4dc0-977c-073076173c11",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "4bca9ba3-71c8-41ac-851a-924cc1d4c765",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "226ec8c8-c297-40c5-9e9c-8aac013b1318",
"db_country_code": "sample string 28",
"feelist_id": "3023a694-fd7a-45b7-9cf1-f9c679e7bbd1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fdec5b26-0c14-4aff-b3a7-f90730eb34c6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5f768612-47d0-4a44-9aa8-66ead1e7f757",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-04T23:25:47.6807071+00:00",
"db_currency_id": "ccd54333-d55a-4a3d-b6f0-cc9dd06ef37e",
"db_currency_code": "sample string 10"
},
"company_type_id": "39556a33-4db3-4427-a958-626dec570080",
"company_type_name": "sample string 32",
"company_type": {
"id": "a4b20532-7be2-407c-89d4-c79a283ce267",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "387cd095-8b0a-44ef-92af-5c207d40ab04",
"sales_organization_code": "sample string 5"
},
"db_language_id": "aa115018-da04-4ecc-ae89-d12fb60b3584",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "58acbc5e-86cd-454d-8165-e6051d5bed67",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "44b44a57-d740-449c-b487-d2085324ab08",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4674ac3b-7658-47e3-91dc-41ae77722101",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-04T23:25:47.6807071+00:00"
},
"company_sector_id": "afdc56f0-491c-49d9-a462-aa4b278deb56",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "45a151c5-ff56-4a4e-b773-000274522d75",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cd534898-67f1-41bf-a8a4-5a7a7dab884d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c84d1eb6-79db-4d02-b282-a5f9967ab19a",
"account_manager_user_code": "sample string 56",
"company_status_id": "1aeafe5a-6f52-4217-82c2-bfdf8b4c4703",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-04T23:25:47.6807071+00:00",
"id2": 60
},
"db_language_id": "89e7efca-9d57-4b69-a72c-75d6e953379e",
"db_language_code": "sample string 7",
"db_title_id": "aed8f861-1cbf-4dba-b698-f980358818ad",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-04T23:25:47.6807071+00:00",
"create_date": "2026-07-04T23:25:47.6807071+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2026-07-04T23:25:47.6807071+00:00"
}