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": "a12f7131-de9e-410e-b12e-47c6c1b4c259",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d0fee17d-a8e0-4caf-8de4-59988d1d6a9d",
"company_code": "sample string 5",
"company": {
"id": "1f884758-2329-4528-a408-839705826449",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-05T23:57:31.604863+00:00",
"sales_territory_id": "0f6252e3-ccdc-44bb-975d-5f73e84e4d50",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cf619159-aa4d-46ad-a3ad-508a78444129",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e001f59a-3349-4348-9fa2-3aae48f6b171",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b09fed52-5915-4b18-9c62-4753b9150c97",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88a1c533-6663-4049-ac78-09e8ed9a8a06",
"db_currency_id": "3b533696-00a9-46ce-83db-698530dd8a02",
"db_language_id": "ce7509f8-890f-4628-82b9-1f74dc889cbc",
"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": "2025-12-05T23:57:31.604863+00:00"
},
"modified_dateutc": "2025-12-05T23:57:31.604863+00:00"
},
"marketing_segment_id": "916fb6f3-fbe6-482f-9513-b1216ca1358a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cd6581d7-9206-4c77-b95e-c76a07f137d9",
"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": "16e1a31f-1187-4f7a-840d-431c00c00782",
"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": "916e601e-2818-48f3-b1b4-d4d539f19cc3",
"db_country_code": "sample string 28",
"feelist_id": "fcb6d0c5-d73f-4e45-b6b4-e5c7e2133dbe",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b7cb7334-0564-42f0-aac0-b26e25a9fc10",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "67d275d2-ac57-4341-aafb-540811a92cd5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-05T23:57:31.604863+00:00",
"db_currency_id": "9c46701b-bd39-4e4c-a63b-216196900684",
"db_currency_code": "sample string 10"
},
"company_type_id": "805e75ee-9895-408e-9de8-15ec011adab6",
"company_type_name": "sample string 32",
"company_type": {
"id": "bfe419f4-2c98-45f7-b6e7-f35b64c05e80",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ed4b3be1-308c-453f-a789-e8521700def0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7a74862d-0cb0-4cc6-9b18-805061870591",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "19abe69c-417c-4110-9fd8-01287d0cb205",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "68f6df72-38d6-4867-9039-8c68e8b812fd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "09fda928-9261-4d87-a138-0a2bc85453ae",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-05T23:57:31.604863+00:00"
},
"company_sector_id": "a3cdeb54-74cf-4bc5-a630-5df949db0ab8",
"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": "f95a315b-0679-467f-81f1-291525fa0f2a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e78d1a8e-1750-4446-b2b6-238beea3d436",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d95356ea-a979-49d4-9f15-c8a23679c31c",
"account_manager_user_code": "sample string 56",
"company_status_id": "10e569de-8e06-4dd3-b301-148071d2c5fb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-05T23:57:31.604863+00:00",
"id2": 60
},
"db_language_id": "b9bc3942-0d08-42e1-967f-26ce7c7dff71",
"db_language_code": "sample string 7",
"db_title_id": "7c46aebc-376c-432c-9663-a885b2ca6906",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-05T23:57:31.604863+00:00",
"create_date": "2025-12-05T23:57:31.604863+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": "2025-12-05T23:57:31.604863+00:00"
}