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": "1ed761b5-2990-48bd-9aa3-a2edf6556f1e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e0742733-c9d5-44d9-a53f-ec6ac6019d6b",
"company_code": "sample string 5",
"company": {
"id": "b97dbd20-bb7f-43aa-851e-4d16bb540959",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-01T08:49:15.8791075+00:00",
"sales_territory_id": "c83274ea-cb9b-4057-abb9-e94f7814f410",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "87456755-7bf0-4ee7-b769-052ca10b00b7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5b10c55d-9af6-4512-9176-821eae1eadcf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "44ba8d57-7367-4e9f-9a12-ff83ac4a5c5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d7c6171-6abc-4b46-8045-93953d7a02b2",
"db_currency_id": "9eeb68e9-ae4d-4cd5-b6ac-62205627ef34",
"db_language_id": "0bf0d664-91ee-444c-87f9-6c4dfe723e71",
"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-10-01T08:49:15.8791075+00:00"
},
"modified_dateutc": "2026-10-01T08:49:15.8791075+00:00"
},
"marketing_segment_id": "7e2773d4-2025-4c00-9d33-124e3d7da5b2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "76c80a64-1ad1-4a0f-8b4a-4b7f89af7a8f",
"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": "f6142903-5b5f-42fe-a92c-a993353527b6",
"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": "549d1d19-56e4-4f15-82f5-6e1aac88c0a9",
"db_country_code": "sample string 28",
"feelist_id": "b64cf0b0-200f-4ff8-9946-bf4014610320",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "efed597b-dbd5-4c55-820d-a598855e2378",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "aac95b35-4b56-4be8-b245-75200b7f3b67",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-01T08:49:15.8791075+00:00",
"db_currency_id": "5cf2e3e6-f67c-4c0b-8d13-52045c543aee",
"db_currency_code": "sample string 10"
},
"company_type_id": "a5d3ac16-85f7-440f-9fbd-ce94285eedad",
"company_type_name": "sample string 32",
"company_type": {
"id": "fbbfc095-79eb-4063-a594-58b8a710fd12",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "93916e84-b34e-45c4-8f93-ed2d172fc792",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4c3a7628-25ee-49b4-a7bf-e850e7140622",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bf8a205d-b9ae-484e-ac65-660a8887f018",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "08689886-917e-4859-86df-0d46dc6ccc61",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ecc61057-2371-436e-8a52-206ad58000eb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-01T08:49:15.8791075+00:00"
},
"company_sector_id": "94c24090-9b39-4ad0-8bb1-468630cc373d",
"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": "179d1592-91d6-4e18-874e-766a25dab7b0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "64dfc984-ee8f-42e3-a64e-5bd90b730217",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d75c41cb-6142-4f4a-af55-836b01f82638",
"account_manager_user_code": "sample string 56",
"company_status_id": "cde44987-65e4-407b-ada8-db84e61a8e11",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-01T08:49:15.8791075+00:00",
"id2": 60
},
"db_language_id": "782dc29f-2ca9-4d9c-b7bc-ba31fd9e0eb8",
"db_language_code": "sample string 7",
"db_title_id": "e2f3f422-0f56-441d-b594-96891acf269a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-01T08:49:15.8791075+00:00",
"create_date": "2026-10-01T08:49:15.8791075+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-10-01T08:49:15.8791075+00:00"
}