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": "cf6e3e83-4a88-41e7-a869-91fc11a5bd8e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0f34d55b-c556-4b9e-804c-7df75eb7047b",
"company_code": "sample string 5",
"company": {
"id": "071f03fa-e75b-40dc-a6c3-6dddd13b1735",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-14T19:24:46.9872817+00:00",
"sales_territory_id": "996cb2b3-17f5-4f2c-b9c6-830e20cf7ea4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "312d2c67-7284-43fc-b3b1-12d3d2c18840",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2464d9f0-310b-4f22-80b0-75404051115d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "45b9b48d-d600-480d-9f1d-bd4c82d33c92",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "92117406-b941-4c8c-ab5d-56386b08c150",
"db_currency_id": "c7dbfefd-eb85-43dc-b68b-355130819176",
"db_language_id": "d225c45b-6772-40b7-a506-974cd2d23681",
"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-07-14T19:24:46.9872817+00:00"
},
"modified_dateutc": "2026-07-14T19:24:46.9872817+00:00"
},
"marketing_segment_id": "651056ce-f91d-4c61-8436-6d98ed37c03e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8da42ba3-eb75-4b7e-82a8-3c2444654944",
"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": "629c9d79-165f-4798-8a90-22eb174dcfbd",
"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": "a93c563a-c44a-41c9-8478-ba2ba6168e04",
"db_country_code": "sample string 28",
"feelist_id": "ba571e81-8d6a-42e5-9ad4-35ec0bbc3bbc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "71398f26-e489-4f13-b857-80bce83d862e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "62704314-dfed-4a58-aa63-9c094e119783",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-14T19:24:46.9872817+00:00",
"db_currency_id": "412d75ad-6d75-46f4-8847-d27101437cdb",
"db_currency_code": "sample string 10"
},
"company_type_id": "3057ac80-c2bc-44e0-91cb-69dc12940b63",
"company_type_name": "sample string 32",
"company_type": {
"id": "7a08501b-0a6a-4d17-b8dc-61a40745a723",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ac3070bf-4deb-42ed-9ca2-595d0d15f18d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e87ef710-3357-4f5a-81c0-880e656bdff8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5708931e-9c4e-46d3-856e-0c1281ddbd40",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "80646e4d-c3d7-4e15-b9f3-430721312f58",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b7f14972-30c8-45a2-a1a3-b4abb3d392d8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-14T19:24:46.9872817+00:00"
},
"company_sector_id": "d0f17ac5-43d9-488d-9e44-a10c7fddb54a",
"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": "8fd1d71a-13e4-450e-bfe8-6ed3db2871fa",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "64393d0e-fb3f-4ed3-8ec0-9e927693f3fa",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a0c874ba-4163-4952-b5f9-307176ad91f6",
"account_manager_user_code": "sample string 56",
"company_status_id": "2f26db65-a4da-4960-903c-cfc15382a78e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-14T19:24:46.9872817+00:00",
"id2": 60
},
"db_language_id": "8e86bf45-36b2-44d3-a706-ace4d8069371",
"db_language_code": "sample string 7",
"db_title_id": "4b265034-3eb0-4567-9726-813192e1d8b1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-14T19:24:46.9872817+00:00",
"create_date": "2026-07-14T19:24:46.9872817+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-07-14T19:24:46.9872817+00:00"
}