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": "73b886f4-161c-481a-b0c6-45bcdf57843f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c3f3faa8-c88c-473d-a05b-ec7904fb27b2",
"company_code": "sample string 5",
"company": {
"id": "2a7f2cbb-1525-4467-ba33-7cde295c6322",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-15T22:06:03.1377622+00:00",
"sales_territory_id": "6640c0a8-b079-445a-b0b4-19d8ff489a37",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c66e5152-3d69-4f59-b89e-2f274f0bf761",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ff5aaffa-4711-4b49-b557-c8c8a4f66891",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0f813876-2fe8-4b2a-83d8-cf29a4274566",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03e3201b-0dcd-49da-a639-9b159409a87b",
"db_currency_id": "630cb01f-24f8-4f1b-94df-e34f49bae564",
"db_language_id": "df01d407-7d44-4117-96e9-36a216342b44",
"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": "2025-09-15T22:06:03.1377622+00:00"
},
"modified_dateutc": "2025-09-15T22:06:03.1377622+00:00"
},
"marketing_segment_id": "d4d17c60-131b-49de-bafb-15b4f9b8fabc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c47317a2-133d-488f-a7a1-d70b6f20a323",
"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": "67ca0402-6f00-471a-adf0-35707882a42a",
"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": "4512202a-0ec6-401c-9ffb-43dac8254cb5",
"db_country_code": "sample string 28",
"feelist_id": "c55d2620-c3e7-4622-b1b8-cf0bec536a4f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "85b87b4c-0ee5-4917-ab92-a7bcca4c52d2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4a9dc7cc-cc44-424e-bb40-8076b143ff8d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-15T22:06:03.1377622+00:00",
"db_currency_id": "387df795-e5d0-494d-9ae6-3bba05ab34bc",
"db_currency_code": "sample string 10"
},
"company_type_id": "2ea98bbd-752a-46a4-bccf-3eaf0dbfe004",
"company_type_name": "sample string 32",
"company_type": {
"id": "24c8af44-22f3-4a54-b441-f57c4e250469",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7aefff22-e87a-4e3e-8181-c0707a704e65",
"sales_organization_code": "sample string 5"
},
"db_language_id": "411bf255-b784-4478-9c99-0674d9f89549",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "40a6b505-64b0-402e-afea-8d4eff2bd3a4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c2eda5ed-29d1-470d-9ac5-61486de61365",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c2563d77-d6ad-4ebf-bbe3-dd0fa4d805c6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-15T22:06:03.1377622+00:00"
},
"company_sector_id": "1afe5235-de2f-45ee-8383-678810439d7a",
"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": "0e29d66a-b435-43a1-b85f-4fac32d5c234",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b073e3ac-0f5a-4d20-bab7-fa590df0a330",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4c93263f-1e5c-4241-9b83-775d69940a9e",
"account_manager_user_code": "sample string 56",
"company_status_id": "f26aefc7-97fd-4ff5-8131-207a521feb16",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-15T22:06:03.1377622+00:00",
"id2": 60
},
"db_language_id": "01922ad5-b2c5-4972-ae91-a2bb009718e2",
"db_language_code": "sample string 7",
"db_title_id": "24e00a35-ac69-4bc6-82aa-42926b1bf85e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-15T22:06:03.1377622+00:00",
"create_date": "2025-09-15T22:06:03.1377622+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": "2025-09-15T22:06:03.1377622+00:00"
}