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": "b03a5a63-6b9b-4c47-92ab-80986ed6b0df",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3b9e5030-e3e3-4bb9-a8b5-4041d44c7a41",
"company_code": "sample string 5",
"company": {
"id": "01b6400a-dd33-41fe-bc20-22af4348f8b1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-03T17:53:03.9861171+00:00",
"sales_territory_id": "955e6f22-01a0-4ba8-94ad-14b94c8667c8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bb080ef5-d11a-4b52-ac9a-53f1db88eaa7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d8ddd220-e831-4275-b530-e71e61411014",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "142e7610-7a5b-4081-9583-ae808e1fa991",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "277a1476-3324-4b6b-99a1-5a88511613fa",
"db_currency_id": "d4439fe7-f1ee-40f4-90b5-c0a63ab1408c",
"db_language_id": "62016c4e-1355-4c43-a91a-fffb7c23ebbc",
"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-01-03T17:53:03.9861171+00:00"
},
"modified_dateutc": "2026-01-03T17:53:03.9861171+00:00"
},
"marketing_segment_id": "d7a14b35-b3bf-4796-91c0-d043f13f87c7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "595b4f1c-57d9-4a77-bf63-31be9a3a0fd0",
"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": "1fbc4d49-d43a-4fdf-a19c-9d31c9badccf",
"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": "a2260c03-8451-48cf-86af-c7bdc6dec996",
"db_country_code": "sample string 28",
"feelist_id": "3c9b4454-4883-49c7-95e9-a993c9858a7b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a636c6da-3dfd-4b42-ab11-8cf56ddc8bb0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b3f71b26-cd9f-4a6f-a4f0-09c0cb7ff3e3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-03T17:53:03.9861171+00:00",
"db_currency_id": "b031636f-2e92-44ea-8099-70607fb16e5f",
"db_currency_code": "sample string 10"
},
"company_type_id": "79a32ae3-73af-48ca-98d6-d523eb94a81b",
"company_type_name": "sample string 32",
"company_type": {
"id": "49d5a03b-7a1f-446a-a97f-1fd468e7bb92",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "00f43a2d-2ac1-4be8-82f0-bc7b304177df",
"sales_organization_code": "sample string 5"
},
"db_language_id": "adf429b8-f0a3-4f42-b74d-547919688bd1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c46b4def-7c93-41c2-acb7-f85f997cfe3b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "faffdcd6-dfd0-446b-b6d8-308543169c20",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ea8b8a41-8d85-460e-a542-0ea8ebd9f94d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-03T17:53:03.9861171+00:00"
},
"company_sector_id": "2ee94eac-4e36-415f-9b7b-aead7cc729e4",
"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": "7ac3e8be-0d3a-46e5-aa0f-987dabb95218",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9faf3401-eba3-43cf-b65a-03838174ee7f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3f88d320-d037-4a54-960d-773a841dc335",
"account_manager_user_code": "sample string 56",
"company_status_id": "4a175c70-33a5-4952-af14-e86bb2c5b0e8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-03T17:53:03.9861171+00:00",
"id2": 60
},
"db_language_id": "323a514d-32cf-4b25-a8fa-01375d81b212",
"db_language_code": "sample string 7",
"db_title_id": "69c5b397-e283-4954-955b-fabb04015930",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-03T17:53:03.9861171+00:00",
"create_date": "2026-01-03T17:53:03.9861171+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-01-03T17:53:03.9861171+00:00"
}