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": "5d4acb0f-aefc-4f1d-ab36-9b40f47be6b2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "72a165a9-fc3e-4739-9089-a047b3a5d660",
"company_code": "sample string 5",
"company": {
"id": "22dafa4d-0193-4c81-8d33-bb00c3b3a770",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-02T03:48:36.0375422+00:00",
"sales_territory_id": "c8aaada7-15ef-4475-a7a2-2232ceb5ebaf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "38445647-4859-4e55-a16f-64430c51aaea",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d1de81c7-208e-4111-ba9b-fb817d6c8d2e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f46f4450-a247-4b25-b271-59fa87b69dbc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41c70d2c-d750-4562-9219-82c5dd264f82",
"db_currency_id": "23849925-e0aa-4395-b0cb-7ebc63e298fa",
"db_language_id": "2755aa46-f7e7-4311-888d-2735301d8183",
"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-02T03:48:36.0375422+00:00"
},
"modified_dateutc": "2026-06-02T03:48:36.0375422+00:00"
},
"marketing_segment_id": "0e12ffc0-a519-4a68-a6b2-154fabd3c66d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8e01febb-c265-44d5-ad41-8d48790a5e2c",
"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": "5fbefd28-8664-4198-9a32-2fd2a52ed56b",
"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": "835d7149-ffd6-4484-8904-2e0b8808af14",
"db_country_code": "sample string 28",
"feelist_id": "b99c943a-4247-4bd6-9653-91dd46ebbc70",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e59ca1b9-d3c6-4e19-b300-d54787fb3ced",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "086e8d2a-2df7-475b-a680-be8a15df2975",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-02T03:48:36.0375422+00:00",
"db_currency_id": "dbbc45d0-160d-48ee-86b6-d6c6bc0ad6ee",
"db_currency_code": "sample string 10"
},
"company_type_id": "96d20723-c3bb-49e5-b8ab-eea28a979a0e",
"company_type_name": "sample string 32",
"company_type": {
"id": "6ae484cc-5ef7-4a51-be7a-a245f86b97f0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "30662c6a-a099-4829-85e3-110c37a20f87",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5eb64a6f-8591-40d0-a267-77c8943a22d9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9c69058a-4c52-4d96-b7fc-d29a47187117",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f19d772f-9057-47c7-95f3-63ce85133320",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "222e48c1-996b-4dbe-99e1-297e9f0bef23",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-02T03:48:36.0375422+00:00"
},
"company_sector_id": "d005bb8a-f4ee-4473-a059-b6cf6517d8ca",
"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": "1fca780d-9a8d-4885-bc2e-69744fa8c150",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "86522b84-dfe7-43ca-94b6-373943368c78",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8628638f-ecfc-4a19-a6f4-bc6294255046",
"account_manager_user_code": "sample string 56",
"company_status_id": "3197556b-c5df-407f-9428-c66d82cdd340",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-02T03:48:36.0375422+00:00",
"id2": 60
},
"db_language_id": "3b05d315-3966-47ef-92cc-3a73541d696d",
"db_language_code": "sample string 7",
"db_title_id": "3a0e1997-5053-4855-8936-6988592371a3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-02T03:48:36.0375422+00:00",
"create_date": "2026-06-02T03:48:36.0375422+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-02T03:48:36.0375422+00:00"
}