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": "6843322c-1462-4d4f-9074-bd36777fd69c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "045d5268-a9ef-4d55-9ee5-c3ac53cb43fa",
"company_code": "sample string 5",
"company": {
"id": "c55e72be-4608-4abf-b618-578163d60c1b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-15T06:37:45.9696087+00:00",
"sales_territory_id": "7ff5511a-c063-4bd0-b5cc-e5e41ddb6d6a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b9ce3f77-0aa9-473b-9da2-7aff1ff4bcb4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a88212f-8854-4bf1-8261-7599bcdf7f07",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3ba27416-4c7f-4855-85c1-1bccceed824d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c8fa9d4c-dc95-48f3-9721-f152699e027d",
"db_currency_id": "bbe2d210-dd7c-4bed-8b3a-84c7bd6f27d3",
"db_language_id": "089d7f04-71f6-436a-983c-eadfe3592b6d",
"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-05-15T06:37:45.9696087+00:00"
},
"modified_dateutc": "2026-05-15T06:37:45.9696087+00:00"
},
"marketing_segment_id": "f0011a62-7d9a-4f65-be67-e2c9eff10916",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d910e2f7-8beb-42a4-9ff3-da2490d1c28b",
"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": "7a2c4082-438f-4bf1-b701-fbc667b1a4f0",
"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": "9c34d44d-cb64-4604-b40c-ac2d98e227b2",
"db_country_code": "sample string 28",
"feelist_id": "a42cf3a8-abcb-400f-9c5d-fa91307300ec",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "455c38b5-e6c7-4b1d-923b-14f4efa1c258",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fe69a3d3-32f0-40df-930d-02e6b564de0f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-15T06:37:45.9696087+00:00",
"db_currency_id": "1c9ec8bf-1e4b-4456-b07c-a8ab42a26cef",
"db_currency_code": "sample string 10"
},
"company_type_id": "266b858f-b201-42af-8d90-11cb074ad43d",
"company_type_name": "sample string 32",
"company_type": {
"id": "7b49da23-d82f-4d66-99ef-deda9dbd8fcb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "655b3a7a-3909-4656-b859-d8f4ec1af139",
"sales_organization_code": "sample string 5"
},
"db_language_id": "05af0e88-7969-40d7-84b1-f41669e7f1ff",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "36987bd3-0095-4c26-9777-6a86a2b5a648",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c39582c0-b767-4bcc-b494-17e7efcd08f7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3a5b63a3-5f0c-4dbe-a5e0-59ce98191697",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-15T06:37:45.9696087+00:00"
},
"company_sector_id": "15f02255-e209-4fc7-8216-43580b472085",
"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": "b3d7e35e-4ea0-4d1a-bbd9-97ba1b804292",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d14a75bb-1311-4cc4-82b1-a77536df4b02",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "44275e5b-c4f7-4252-a2ec-e91363ea0044",
"account_manager_user_code": "sample string 56",
"company_status_id": "6340ed22-0eb2-4d77-aa0a-ec397f2b5a17",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-15T06:37:45.9696087+00:00",
"id2": 60
},
"db_language_id": "29a6d4fc-b30d-45f1-b2bc-4fd26cca2e43",
"db_language_code": "sample string 7",
"db_title_id": "27f27713-0f19-466f-8877-1839795cec36",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-15T06:37:45.9696087+00:00",
"create_date": "2026-05-15T06:37:45.9696087+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-05-15T06:37:45.9696087+00:00"
}