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": "0d753b77-434b-45ac-ae4e-5570c257fbb8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fe041430-7930-4523-a3a9-b4fe9a0e1239",
"company_code": "sample string 5",
"company": {
"id": "df29f6fb-90ae-4daf-8630-49f606978667",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-07T12:33:16.7885875+00:00",
"sales_territory_id": "d4ff0253-03a5-49cc-b21c-824cb6830785",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2e760d96-83e7-4ac1-bd6e-4b93be8e52cd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7d324e92-ec99-4557-a39f-d7f7cf02ed81",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e06f1b9c-e684-454d-9425-d3bbdb4eee42",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d486a1e3-278c-4b12-bccd-d1d878e2fa0e",
"db_currency_id": "bd7da21b-a974-4596-a316-d46499b986d8",
"db_language_id": "8b266f29-cf99-40fe-bba7-b6980b2ef32f",
"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-10-07T12:33:16.7885875+00:00"
},
"modified_dateutc": "2026-10-07T12:33:16.7885875+00:00"
},
"marketing_segment_id": "747e8a9f-83ec-4d38-9404-7d89f1127bba",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dcc8fca2-be10-400f-b9af-91b0d367d025",
"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": "175b78f4-18b7-4b5f-9b3f-cf73478a73f1",
"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": "ff5f902b-7739-4db1-91cb-f6e25a70fa51",
"db_country_code": "sample string 28",
"feelist_id": "9775c167-c556-488a-8287-9660edc6f42f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "38bb502a-5f16-4240-aefd-1f3679adea55",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a9684477-fd76-4e9c-baec-5afaffde0a0f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-07T12:33:16.7885875+00:00",
"db_currency_id": "c6d750b7-8a8e-4d6b-8a13-0f91073494b3",
"db_currency_code": "sample string 10"
},
"company_type_id": "065e59b9-6ed8-453a-ba34-2de4e8c76640",
"company_type_name": "sample string 32",
"company_type": {
"id": "f07ad974-99d2-4d99-8904-2813b5e2f2bf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1378372c-31d4-4cd9-8007-2bba774bd12d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6e51c6dd-0c04-475e-b818-dded1620dad2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "594e3247-a347-45b7-81bd-55899b32a379",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "24c75a20-3c80-4432-981e-ca1c1a6856ea",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e054bd3c-9221-4556-b486-e8ce822b9b7e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-07T12:33:16.8082036+00:00"
},
"company_sector_id": "7497f9eb-4e2b-4357-8c79-17b11053fb04",
"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": "cd1c888e-50c7-4696-9a5b-12a07dc0d70d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9364f312-6de8-4297-bcdf-824ae77d54c9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2c7638e7-61d5-42c8-9fe3-17038e4cbad1",
"account_manager_user_code": "sample string 56",
"company_status_id": "e3d56936-8b8f-4dd1-b909-3393db6226c6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-07T12:33:16.8082036+00:00",
"id2": 60
},
"db_language_id": "0326725e-7429-4544-8bf0-5218695956a0",
"db_language_code": "sample string 7",
"db_title_id": "b15bcf9d-84fa-42ee-8b7b-02595bf667a3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-07T12:33:16.8082036+00:00",
"create_date": "2026-10-07T12:33:16.8082036+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-10-07T12:33:16.8082036+00:00"
}