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": "01a35f71-d254-44ce-aabd-39537b3f59f8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7d43e7cd-41cc-4b21-8b8d-7b61f3095a71",
"company_code": "sample string 5",
"company": {
"id": "edc5a085-80b7-4a5d-8cb8-a533e13904fb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-09T05:17:47.455543+00:00",
"sales_territory_id": "09d81c5f-aab0-4f9c-81d0-0ca847869bfd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0bcff622-9f52-4a11-ae4d-9fa468b23919",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "934aa999-7e25-4020-a480-a79760833303",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a896f650-b29e-488d-9181-6fa86b494a35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7938994d-654f-4ec6-b183-b07bd3545d4e",
"db_currency_id": "5f1de101-31af-412c-9410-0d53d471e19e",
"db_language_id": "e6ef71da-c348-4d59-abfb-b610e689509f",
"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-09T05:17:47.455543+00:00"
},
"modified_dateutc": "2026-09-09T05:17:47.455543+00:00"
},
"marketing_segment_id": "daee0703-dc28-4de9-87f4-05bd1d8070c4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "aab2dc8b-3cf1-4cd7-8155-c056d94dda86",
"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": "eba44ddd-acd4-4b69-8f9c-10d41736b01a",
"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": "9d64c4f7-defd-4bed-9be3-028120120b36",
"db_country_code": "sample string 28",
"feelist_id": "a8154b0f-07fb-4f60-a976-694a860a2003",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3030af18-6343-40fd-b897-8f430a3e42e1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2f6dace8-7b3e-42c2-a124-21dd711aab32",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-09T05:17:47.455543+00:00",
"db_currency_id": "793993e3-082a-4241-9329-3f66937c3b81",
"db_currency_code": "sample string 10"
},
"company_type_id": "b6e752d3-cc2f-4ef9-b0a4-9d96faa46c41",
"company_type_name": "sample string 32",
"company_type": {
"id": "1699bcf9-8e95-49a2-a4cd-af33373caf0b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6c900d61-f4e4-4042-8fe8-d79591cc93a1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "30ebabe8-b5aa-4ded-aa59-5c37f75b8be0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "42a0bf6b-4f44-48d0-9262-89eebdab986e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1a799232-c8d8-42fb-b3da-db2ae036a865",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c35c1f91-96ee-4510-b281-0e8d8befa401",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-09T05:17:47.455543+00:00"
},
"company_sector_id": "9f24278c-86b3-4853-a659-8d0848c3794e",
"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": "9f29df88-de39-4e13-8ce4-e2d9bca17cf3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8f5c853c-2101-4f0d-bd71-1321e960b24b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0fa90c88-22f6-4437-a2a2-7be4f30dd28e",
"account_manager_user_code": "sample string 56",
"company_status_id": "81f60ab1-473b-4a0c-a09e-fef4f19425d6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-09T05:17:47.455543+00:00",
"id2": 60
},
"db_language_id": "401ce445-ab26-497e-b212-e09a49654ae5",
"db_language_code": "sample string 7",
"db_title_id": "a2d5396d-8306-4268-8b7d-f4509c679bd4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-09T05:17:47.455543+00:00",
"create_date": "2026-09-09T05:17:47.455543+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-09T05:17:47.455543+00:00"
}