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": "6cc66570-f6de-4c09-9f68-f3b0ce9c8a42",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a658c99b-2450-4658-9875-6e746b247ecf",
"company_code": "sample string 5",
"company": {
"id": "10ee4c47-6b79-4fc5-aca1-411e6b4be032",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-14T02:03:23.5475536+00:00",
"sales_territory_id": "f25504a3-ba8b-4bd8-b853-2e217827626b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "36180175-f0a1-45d8-81a1-3a2079c8b4d4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6a0e7408-3a45-4611-836c-89d88acd5c60",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0b6c8a85-0c7a-4472-b9d0-6773b3f36b92",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9084954a-59a4-40ae-a5ae-799e0d29f095",
"db_currency_id": "c4e78546-acc4-40cc-aa62-2ccd77bf8fd4",
"db_language_id": "a59140b5-dee7-4411-a2a5-c4828c613267",
"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-06-14T02:03:23.5475536+00:00"
},
"modified_dateutc": "2026-06-14T02:03:23.5475536+00:00"
},
"marketing_segment_id": "1242360d-d97a-4e5c-8260-6ca4f2128347",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "94644568-a5af-42b9-851c-f41720554192",
"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": "e9b845e1-f2a8-4b0a-8146-fddb182301a9",
"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": "8d59d6a7-3d86-415b-bb46-a872a127e592",
"db_country_code": "sample string 28",
"feelist_id": "2c2ec2a3-5a9c-4de8-80bc-a7b650fca635",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "98ae4666-57c7-4ff2-a659-ce995d38cf1e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "35fa72e2-6b49-4123-b841-e98e6995c347",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-14T02:03:23.5475536+00:00",
"db_currency_id": "1eb0e4a2-fb66-4052-96b3-653d0d02b8e2",
"db_currency_code": "sample string 10"
},
"company_type_id": "3146aea6-e39d-4d85-9931-6aaaf31e7a5c",
"company_type_name": "sample string 32",
"company_type": {
"id": "468e91fd-f24a-4ffb-ba81-6d92ae4ff0f8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "14c6b455-5600-4fb0-8262-61b12fae8cd2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "121f0ce3-f0b7-4c89-bcc5-552f7f2d9735",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7a1aad13-1210-4a87-bab6-bc67403f661a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1dfb4b6d-2498-4bfc-acd6-38d2373ee77c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e0df9151-8d3a-42fb-8693-ea09b6dc4b1b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-14T02:03:23.5475536+00:00"
},
"company_sector_id": "0ccba8d4-fe09-434c-bf65-327985b3a736",
"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": "e1a25e3b-8c20-49df-92fe-d0910b5ca400",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1443ea33-55bd-4766-9cb8-7351c6a5a4d8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5a13a3be-bb3d-4c16-bd40-6debaf61f7e9",
"account_manager_user_code": "sample string 56",
"company_status_id": "13bd7984-c650-4f3c-ac63-32695e1e8350",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-14T02:03:23.5475536+00:00",
"id2": 60
},
"db_language_id": "a29848c2-c19a-4988-9140-5df0ec6f7d79",
"db_language_code": "sample string 7",
"db_title_id": "a450984f-e67c-4cab-8883-98f82deccef9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-14T02:03:23.5475536+00:00",
"create_date": "2026-06-14T02:03:23.5475536+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-06-14T02:03:23.5475536+00:00"
}