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
{
"id": "49c935ed-cb99-4d55-95b4-525195f2011c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "725b1cd0-1548-4173-ae6d-824c86d1ef53",
"company_code": "sample string 5",
"company": {
"id": "081c8fa3-793a-4f32-a2ea-8203337d643b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-18T18:01:14.8716436+00:00",
"sales_territory_id": "1efc77ef-df93-40d5-ba8d-c87c15c1d1a2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e3399332-5dca-4cca-9dff-391bf214f263",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e07ba385-bf7a-4d54-b5d9-b878812fb119",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "73744787-5e13-43d3-9e32-7153b1dcbf02",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3161039e-8afe-4bbf-a3d6-af78431042b0",
"db_currency_id": "7f58873b-a596-480c-bb91-4187ee297e36",
"db_language_id": "0a3f63ed-bb5d-432a-9222-75790ebeda04",
"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-11-18T18:01:14.882774+00:00"
},
"modified_dateutc": "2026-11-18T18:01:14.882774+00:00"
},
"marketing_segment_id": "1e3f0842-29cb-4b28-8a99-e35bb18d527f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e13d5edc-cc2b-4dc7-8b69-82b46799faf9",
"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": "55ba9c23-4f69-46a2-8966-3a42375b3398",
"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": "6841d482-56fe-4a5d-932c-44ad7b9f034a",
"db_country_code": "sample string 28",
"feelist_id": "34effa3e-847c-4f90-93ab-27ccc0949ea2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "44d540e8-c279-4d33-91b7-2cab903b18a0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7ca32929-f70c-459e-9a22-226cf53815f0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-18T18:01:14.882774+00:00",
"db_currency_id": "1bd8d84f-dfa9-4a4a-936f-e4e379c77392",
"db_currency_code": "sample string 10"
},
"company_type_id": "921adf2f-1ea9-40ea-b601-8d77954501e6",
"company_type_name": "sample string 32",
"company_type": {
"id": "28a15d03-a5a8-4a8e-840c-109324cb2c6e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c364a92e-a9df-4c9b-9d02-0a5031877845",
"sales_organization_code": "sample string 5"
},
"db_language_id": "235400e6-b391-4f18-b48f-6f32be5016d2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "94dde09d-5b4b-4be3-a766-f25c316fa357",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "71f44d2a-92c3-4b27-82e3-d06c83a280f7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5cdd10c9-a7f8-410a-8f68-ad7ade598551",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-18T18:01:14.882774+00:00"
},
"company_sector_id": "c6fa7133-1836-4ad4-ae63-181a32887962",
"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": "7b6c9f14-3a36-4b09-92c7-21998eeb01fa",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "68afba59-8229-4dd8-acee-2d1087c6ff6c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9153f3c5-9e69-43fd-a8b5-403cf7081758",
"account_manager_user_code": "sample string 56",
"company_status_id": "8f61532d-a430-4119-9831-e5d7c9411c83",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-18T18:01:14.882774+00:00",
"id2": 60
},
"db_language_id": "350ccf3f-f1cf-42bd-9c05-ad1a347084b4",
"db_language_code": "sample string 7",
"db_title_id": "eca45da6-e857-44c0-a8ca-caea94146601",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-18T18:01:14.882774+00:00",
"create_date": "2026-11-18T18:01:14.882774+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-11-18T18:01:14.882774+00:00"
}