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": "02e7d4e6-fce5-4cf9-93ea-3a5cdef565df",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9499683f-29d9-4540-8152-6dae678863c0",
"company_code": "sample string 5",
"company": {
"id": "76ba94ef-f705-4a16-9e31-a2f050861e7b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-16T11:24:37.2418849+00:00",
"sales_territory_id": "dab31406-303c-4b3e-a863-e7e89f646ce2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a0891a17-6c49-4e77-a0d5-3564e81fd18c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a3354ae2-ba2b-435f-bcf5-a3cb82f1230f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7b2fe7a9-7580-4112-838d-f5fd66af69a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d19bfbe9-0e38-401c-88b5-4e9086dd7828",
"db_currency_id": "cd972063-4bd8-4207-b7fc-f61c0426fdbb",
"db_language_id": "a1728b20-2145-45e8-954a-cb51f23e1e55",
"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-16T11:24:37.2418849+00:00"
},
"modified_dateutc": "2025-12-16T11:24:37.2418849+00:00"
},
"marketing_segment_id": "787f4ad0-de3a-47ff-b121-d3c4252e84e6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d9f6857b-b015-4d67-a594-8d7c84f622f4",
"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": "b4cab5b3-5210-4750-a07d-873dab6a68dd",
"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": "96394f66-c11d-45b6-b4fa-bfe55b3a0fe6",
"db_country_code": "sample string 28",
"feelist_id": "d038228e-3378-4457-bba9-4cba108aa577",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3e3d209c-147a-4c22-aef5-937bf65de581",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e9838245-ede9-4b40-bf6b-24bdd7b83795",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-16T11:24:37.2418849+00:00",
"db_currency_id": "1d3f4984-7b27-4271-a2f5-a629f50d6fda",
"db_currency_code": "sample string 10"
},
"company_type_id": "94f7ec6e-c26d-42a7-acb3-a08ea108ed42",
"company_type_name": "sample string 32",
"company_type": {
"id": "6ab2bf61-981f-4b92-8836-e62477d363b2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fb0e762b-58e5-41ed-b775-e236cf3dd57d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "43323cab-c2bd-47e0-aa6a-07338a334760",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "af4748e0-e25b-4063-a72e-a69c7c2bfc33",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6221be6e-0548-49a8-9d9a-3a93f4687451",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b9102fbf-2641-466d-9e8b-0264a0cbeb3f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-16T11:24:37.2418849+00:00"
},
"company_sector_id": "a4a29d21-1814-4df8-876a-f862fc6b2cab",
"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": "77c04a91-3608-4ebc-bc1c-e274adcf5830",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "678ef8f6-19a1-4a97-8dfd-39a7ca27bdf8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d8803634-4d1e-45de-839c-54e1614d0062",
"account_manager_user_code": "sample string 56",
"company_status_id": "0a78710a-ca7d-4e55-b010-5cd98eddb7b6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-16T11:24:37.2418849+00:00",
"id2": 60
},
"db_language_id": "d0257104-ced8-49b0-8af4-e8d87909747d",
"db_language_code": "sample string 7",
"db_title_id": "9d521de3-0956-4fca-8594-0d14bfe2cc15",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-16T11:24:37.2418849+00:00",
"create_date": "2025-12-16T11:24:37.2418849+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-16T11:24:37.2418849+00:00"
}