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": "757188fb-f8c2-4a87-991c-a28de792ecba",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dc700e95-c55f-4d28-98a8-f5c3e780bdd1",
"company_code": "sample string 5",
"company": {
"id": "03a2847e-6569-4816-a320-cf6da125a401",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-07T19:28:09.7911977+00:00",
"sales_territory_id": "29fcad23-b5df-4012-8974-4acfb9cc6259",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bc1e5b3f-ce24-4028-8ab8-8157284b17e1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ef9ca8a0-0305-4257-9be4-46296762b683",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d0978d7b-dfc8-48f6-8ecb-8d957add5d40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43d032b2-af5b-470f-8114-cc1e7049dad4",
"db_currency_id": "7c0b17dc-5097-408a-81e8-bf0bd46e5abe",
"db_language_id": "27902b02-2109-4686-aa7a-4112b7a6d336",
"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-09-07T19:28:09.7911977+00:00"
},
"modified_dateutc": "2026-09-07T19:28:09.7911977+00:00"
},
"marketing_segment_id": "45c57a4e-6db1-4cb1-8616-064daaf00757",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "af83f895-a639-41a5-94aa-7cebbd9898b7",
"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": "6bcbf0a7-0024-4709-bba6-2712bbd540da",
"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": "40cf13b6-09c6-40c0-8e12-b671ded3a288",
"db_country_code": "sample string 28",
"feelist_id": "1c5b0c8b-59c5-41cb-9fa0-1d93693da6c2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fa3b1777-c187-459f-87bd-befb91562d1b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a289b7df-1931-41a0-a6de-9c2910669809",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-07T19:28:09.7911977+00:00",
"db_currency_id": "354bf8ad-2a90-4807-bf93-55b8b5dac864",
"db_currency_code": "sample string 10"
},
"company_type_id": "249dc8a8-b6e9-47c7-a666-104bfc4199f7",
"company_type_name": "sample string 32",
"company_type": {
"id": "32f9f25a-0aea-44be-b016-3abfaa0d94b5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b4a52d0c-b6d0-4d2f-a8b3-4be8946b81a3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "68a53e22-3461-4520-bade-1dec4dda23c9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7669c67b-e400-470b-bacd-c7e21e457ea0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8a7791f6-6d65-4778-8b3b-73427982d24e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e0fe8491-22db-45eb-86d2-214005813d39",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-07T19:28:09.7911977+00:00"
},
"company_sector_id": "b6e10028-a2e9-460a-8844-2d63123ae14d",
"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": "6037b8d3-9601-4d53-aae7-c14ec4974cdd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "35a036d7-6123-47c4-a90a-9c998670911f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "87da7c21-3b11-4c5d-b541-4078913fcdff",
"account_manager_user_code": "sample string 56",
"company_status_id": "9444ef79-8c86-49ad-b236-316d0e6b2429",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-07T19:28:09.7911977+00:00",
"id2": 60
},
"db_language_id": "04634c18-7834-4086-aad3-35eb79836b95",
"db_language_code": "sample string 7",
"db_title_id": "13d5a25b-3405-470d-9f2c-d5754d39a235",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-07T19:28:09.7911977+00:00",
"create_date": "2026-09-07T19:28:09.7911977+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-09-07T19:28:09.7911977+00:00"
}