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": "4db83c46-d0c2-48eb-88d2-067b870fb3d4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5db297c8-b986-4d9d-8ce7-c52e7c0d4af8",
"company_code": "sample string 5",
"company": {
"id": "e6430d0e-ed5a-4890-a579-ec4ebb5eec11",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-27T06:05:48.5850442+00:00",
"sales_territory_id": "28ddeb33-576b-4717-a4a5-8b7665dc46d6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "57adeb5b-54e2-4b87-8715-9d1d24317371",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fe1c9daa-53cb-4de0-b2b5-0dc739e81606",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c7aae7ad-16e2-4390-95e4-b4b2a70e0976",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa9c80c3-48a7-4d38-936d-073b15374c4a",
"db_currency_id": "0f50de01-8279-42c8-93a3-a5732cdf097e",
"db_language_id": "88cffaf1-3a87-4886-8e13-3999b99aa1cd",
"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-02-27T06:05:48.5850442+00:00"
},
"modified_dateutc": "2026-02-27T06:05:48.5850442+00:00"
},
"marketing_segment_id": "cfef7ad0-35f4-4a70-a55f-b6670295eac0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7226b678-bde0-4926-8cb3-76359326bbb5",
"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": "53a845ee-a9e1-418d-b623-0931353da34e",
"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": "aedae4ef-3125-4670-814a-37386c094afc",
"db_country_code": "sample string 28",
"feelist_id": "d3113e47-78b4-40ee-9d6a-e0e40c13bede",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "89164baa-ceb6-4eb6-81da-3ea407a31082",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b74a8e7d-d510-4a13-8bc4-d7f6f77d0ba5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-27T06:05:48.5850442+00:00",
"db_currency_id": "6212be78-bb97-4381-be6e-2106b50ce58f",
"db_currency_code": "sample string 10"
},
"company_type_id": "99aa8cf9-7338-4231-950c-17a1f9379435",
"company_type_name": "sample string 32",
"company_type": {
"id": "5353b9a6-7b45-446f-80c4-60f82e281a3e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "74a3259e-8b42-48d0-8b7b-7ed6fb91013c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e35042a9-ffa7-4a19-8ce1-6d08434f2baa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "050940aa-cb1f-4d66-ae3c-f55351e06164",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "25b5bb3e-f455-4a3d-80b3-917bbad5794e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "abc29918-4220-4566-854b-af11d3d73bc0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-27T06:05:48.5850442+00:00"
},
"company_sector_id": "e4bc355d-d598-4b3a-9a65-4d0d5150e006",
"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": "15a2b58a-3040-42b5-a3c9-c983aec56408",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ab65a1ab-9d2e-4b58-9fdd-866f5d5ba387",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7e4a2afd-97ef-4efe-a701-33991141a40f",
"account_manager_user_code": "sample string 56",
"company_status_id": "392e8a2f-5f13-4e95-850f-c696dd690eab",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-27T06:05:48.5850442+00:00",
"id2": 60
},
"db_language_id": "6728c99f-fd5e-4f2f-a571-0ec0941e14b1",
"db_language_code": "sample string 7",
"db_title_id": "62522bb1-4366-4dd6-8813-1f71ccf82069",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-27T06:05:48.5850442+00:00",
"create_date": "2026-02-27T06:05:48.5850442+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-02-27T06:05:48.5850442+00:00"
}