Retrieves the company 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": "9e68ae29-3915-4437-aab9-f403f132a19c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4c3e114d-5920-47d0-a85b-a4154791e4f8",
"company_code": "sample string 5",
"company": {
"id": "048632b6-6b7f-4d92-9cbe-202d1585149c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-21T10:10:59.5027426+00:00",
"sales_territory_id": "bfc5a234-cbc6-494d-adc7-1a8aaf435007",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "74c21d71-1e0a-41b4-a3d1-e688b425053b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b0f36c6d-443f-4351-b5d7-38e6749aea94",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3baa8854-99e4-47d1-83d7-f611e27baf69",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95b8cd4f-3454-45d6-b782-112ce02edbd0",
"db_currency_id": "495674a9-0ffa-46f6-abc6-38ce83291435",
"db_language_id": "4858ae1e-60b5-4968-85c6-6dc3197a8289",
"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-04-21T10:10:59.5027426+00:00"
},
"modified_dateutc": "2026-04-21T10:10:59.5027426+00:00"
},
"marketing_segment_id": "aa08cb19-c6de-457d-9759-884dcf7f2a75",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7bc86c17-d7de-4e15-a3f8-51372f7c2fb4",
"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": "9f888e72-e4c1-4ccd-b3a5-cbadf4a5d6c5",
"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": "ff1cc191-e015-404f-884e-20fa37955700",
"db_country_code": "sample string 28",
"feelist_id": "0021f6a5-19b3-41cb-808f-f1cce2fd2558",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0eefb19c-4af4-4f77-bee0-6f0e6c2f7a43",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f5edf0f7-e29d-4e61-ad85-5c8cebccbf89",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-21T10:10:59.5027426+00:00",
"db_currency_id": "f4e65445-3adb-4f1a-bd68-31ad5ccf3379",
"db_currency_code": "sample string 10"
},
"company_type_id": "8f9f4095-0716-48bb-8dbb-0f837fecde3b",
"company_type_name": "sample string 32",
"company_type": {
"id": "189068dc-f01c-4e9c-8cda-f8e69d31a1be",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "67538eb1-5de0-4fc1-b09e-ff70ff67b36d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8e13affe-4cd3-4bfb-825b-d5307a1bc5ff",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6971b03d-0874-45e8-a7db-2eef60339f20",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "61a5a0bd-5dd7-4697-a56f-d17fa81d8610",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e05beaa3-5a12-42a3-b20f-281db4db03b3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-21T10:10:59.5027426+00:00"
},
"company_sector_id": "0153ca69-6f75-4aed-9015-4459c36c5200",
"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": "2f626a59-8d3b-4dcb-aa71-3a549ad6d6ad",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "093689a6-3f0e-4017-9abd-eaabdd41b4fb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dbe9b660-afdd-421b-b860-00659af9594f",
"account_manager_user_code": "sample string 56",
"company_status_id": "09353cf1-7c2b-4845-a249-f9987f809b00",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-21T10:10:59.5027426+00:00",
"id2": 60
},
"db_language_id": "87c37cdf-c0d7-4fab-806c-100590a90a45",
"db_language_code": "sample string 7",
"db_title_id": "46604f4e-1db3-41b3-9160-e66ee24606fd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-21T10:10:59.5027426+00:00",
"create_date": "2026-04-21T10:10:59.5027426+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-04-21T10:10:59.5027426+00:00"
}