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": "9c0e4949-f37e-43bc-87c7-af03f691650b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9ce2a374-b01a-47f8-bee8-00453cfc4f0c",
"company_code": "sample string 5",
"company": {
"id": "6070abd8-cb52-4591-9ee6-279a7578e98c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-08T17:18:18.0986569+00:00",
"sales_territory_id": "e7178cf2-0afc-4a33-acdf-fe0fcaa9295f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "82bc4c0c-0377-43d8-9177-4db8db11eb3e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ee4a1d2b-3435-4e5a-8b29-e91415932357",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c7c7d66c-41ea-427d-b251-6b34cc1157e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b9a15d0a-3fde-4c8d-aeaa-ed688d7d380d",
"db_currency_id": "5cd5d612-00a7-42b2-9c08-473f52d53b1f",
"db_language_id": "64fe10e4-11f2-4acf-b693-0b3176b218ef",
"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-11-08T17:18:18.0986569+00:00"
},
"modified_dateutc": "2025-11-08T17:18:18.0986569+00:00"
},
"marketing_segment_id": "91191110-7e23-4caa-8d32-9465ed7f9b87",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "eac7387d-c873-4886-a73f-3158370cf757",
"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": "4ddbf340-5e9a-4142-b5ce-8c2dfb948204",
"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": "30fd17a2-0590-4919-bae7-2fa604d2778b",
"db_country_code": "sample string 28",
"feelist_id": "cbc1c7b8-69a1-43ed-b051-32f89235abb3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a716a406-2cfc-4ca5-b937-7525a784c431",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dc6c9a24-c534-4328-8537-05f46ec776fb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-08T17:18:18.0986569+00:00",
"db_currency_id": "a68edea5-9be1-48a0-993e-85f0ce0f107b",
"db_currency_code": "sample string 10"
},
"company_type_id": "5e60c649-c69c-4ab4-afa3-ee508aff8e66",
"company_type_name": "sample string 32",
"company_type": {
"id": "1e4d36a0-0e09-40f2-842a-503baa184e47",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cf44b9ce-fbbc-41a8-8324-bd9d8abbb1c1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "02e34ecf-528c-4759-ac0d-d1403401451d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8b19e4dc-a09c-46cb-a710-57f113ee4ad6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c8816941-9118-4870-be0e-f2380f6d2dbb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "badf8829-1231-4caf-92e3-51f6d3117515",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-08T17:18:18.0986569+00:00"
},
"company_sector_id": "0451354e-8d69-4795-9e6e-2feba739399c",
"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": "4e5141b8-cea3-4672-b279-c0d7e6e294ea",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4956ef54-de19-4e83-b569-65d0be65709e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "761e1c25-a945-477c-b7f9-93b1b3663d56",
"account_manager_user_code": "sample string 56",
"company_status_id": "c7303b8c-8e35-42d2-86f1-4771982b00fd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-08T17:18:18.0986569+00:00",
"id2": 60
},
"db_language_id": "6b16a476-88d4-434b-9faf-eb48a96df609",
"db_language_code": "sample string 7",
"db_title_id": "0185d841-29ff-4b27-b421-8492e8582242",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-08T17:18:18.1142981+00:00",
"create_date": "2025-11-08T17:18:18.1142981+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-11-08T17:18:18.1142981+00:00"
}