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": "3502fc0e-7299-4d92-9ac0-1bb28a4c6e93",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5c2cce25-719f-4aee-a7a1-4d96ddb04570",
"company_code": "sample string 5",
"company": {
"id": "ba9f6d81-2c08-4350-86a7-f6683d233fcc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-26T19:55:08.380845+00:00",
"sales_territory_id": "6ebc7b08-c950-4c43-a165-351e0d5bcbba",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b862d0c0-9ebf-4086-a0a4-40f17ca6f075",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eb93db66-3968-4b35-8846-af913ec77ec5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7e60b017-7921-45ca-96ac-0f464e45e9f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d610b112-e80c-4be5-bd40-9fa7369c64e5",
"db_currency_id": "07f69c3d-1fdb-4291-95f6-5c1cdcad2c79",
"db_language_id": "2e9988a7-7705-4c44-a63a-2a3912c1f084",
"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-26T19:55:08.380845+00:00"
},
"modified_dateutc": "2026-06-26T19:55:08.380845+00:00"
},
"marketing_segment_id": "7a8f6697-1813-4e8d-88cd-a24432f93faa",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "817e87da-e7ac-4169-95d5-e35c52ab8fd2",
"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": "bb921f66-7d80-44c3-82fd-3a081bc51110",
"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": "ecf60e3c-4d88-4e92-b7bc-8e0a4597898b",
"db_country_code": "sample string 28",
"feelist_id": "0ee780f8-601f-4f67-ba69-57a4953fed7b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3cf324ff-4b21-4863-8576-ed2c3bb62b20",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3373d97e-5e3c-4a99-869d-ad227d88d858",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-26T19:55:08.380845+00:00",
"db_currency_id": "4d93e872-29a2-44e4-8aca-0800af515b80",
"db_currency_code": "sample string 10"
},
"company_type_id": "edeab374-fc8d-48aa-a0e1-d926a6c70316",
"company_type_name": "sample string 32",
"company_type": {
"id": "79e29900-7f1b-435f-a7ca-6d681a64f15c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a8a51094-f18c-4777-a461-2d5a1e3dbece",
"sales_organization_code": "sample string 5"
},
"db_language_id": "aaf2431e-82aa-46ea-a08b-7f412204d04b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "de6ea2f9-a87a-4eca-9a3a-d7e441a8bd66",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3028b096-fe53-4153-89a8-4cf6d59a133b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dcf07f20-3925-4f18-bcef-30918aaa1422",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-26T19:55:08.380845+00:00"
},
"company_sector_id": "3d650ac0-59b3-4740-8f60-e6b2678ff220",
"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": "35adad51-a7e0-40da-839f-5aba9f6e6eeb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ef02e202-2c7f-4cdc-a220-820d4e47405b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d2cf76a9-3a39-4196-a749-8fd67d6ed826",
"account_manager_user_code": "sample string 56",
"company_status_id": "daba8c3b-6ab2-46e1-948d-1b41f1719fab",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-26T19:55:08.380845+00:00",
"id2": 60
},
"db_language_id": "8ce7495c-b457-48ac-ae55-d639c3200dc1",
"db_language_code": "sample string 7",
"db_title_id": "a5220fd5-5d9d-41bb-8238-ea91795187dc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-26T19:55:08.380845+00:00",
"create_date": "2026-06-26T19:55:08.380845+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-26T19:55:08.380845+00:00"
}