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": "d90a7b9d-2c59-4ca6-a5af-87c64e24aefd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5ceb791f-0494-42e0-8f86-b282b817c509",
"company_code": "sample string 5",
"company": {
"id": "dd3ff479-43d9-498b-b888-697ee85412a6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-13T19:50:28.7484783+00:00",
"sales_territory_id": "c4f39119-77d7-46f3-bd80-fa61e3ade696",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4ebe5a90-4baa-42ac-8578-d87919fae61e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "48d5bf12-cee2-40e5-aae5-a19c370605a0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3d2dabb2-dfbc-433e-8562-1c915eee0293",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a70aa7be-0540-427d-bb0b-c5239148d057",
"db_currency_id": "065420e6-4623-4fcf-8a5c-a2b885c69032",
"db_language_id": "f460ec8e-ebe9-4746-bd13-288c244c9ccd",
"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-13T19:50:28.7484783+00:00"
},
"modified_dateutc": "2026-09-13T19:50:28.7484783+00:00"
},
"marketing_segment_id": "763ba681-5827-4f76-8003-e9018f8dd700",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "56f3c6e4-9896-4d28-8246-aa5759a39322",
"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": "d56cb2bd-dc3d-4abc-a931-06436e0a2c48",
"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": "bb64da90-8f99-4f21-a7bd-f7128980f1f8",
"db_country_code": "sample string 28",
"feelist_id": "af8400e7-46c3-4aea-ae0f-ee9efbc78f32",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "92f15785-850f-48c2-b2f5-93c50fd271ed",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4cc3c154-2b19-4038-9aa0-0b0eb41bd442",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-13T19:50:28.7484783+00:00",
"db_currency_id": "77d528f2-0ea0-40b1-b7a1-8eee2e77dd18",
"db_currency_code": "sample string 10"
},
"company_type_id": "26a1f1de-b5e8-4e85-9125-76db4c2d9320",
"company_type_name": "sample string 32",
"company_type": {
"id": "f7a980f8-b3a6-4ed1-93f7-6c16215486d9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d938c63b-4ec1-4cd4-bb9a-e7724f68496f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1838d553-7d58-475b-b9fa-919f213833e5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0e380ed0-5e95-445d-9a36-0029de8df20b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0e8cf81e-cd80-4cee-8662-69ab42dc5321",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "92057397-dc5c-49a3-ad52-3f108e9aae70",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-13T19:50:28.7484783+00:00"
},
"company_sector_id": "28526bbc-52d5-40f7-ad4f-2067b6940023",
"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": "aad23e6b-a2d4-4b65-bcb5-ebfcb7afeff2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5a9f6f38-8941-4a92-b800-6c960d671adf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7e318998-eedd-47a8-baa7-65334a40f9a6",
"account_manager_user_code": "sample string 56",
"company_status_id": "2c8861cc-93af-463b-b29e-7fe6f1edd531",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-13T19:50:28.7484783+00:00",
"id2": 60
},
"db_language_id": "e287a536-72c8-4ea7-8862-3cb4590ecd51",
"db_language_code": "sample string 7",
"db_title_id": "41b745ba-696c-48bd-8779-e6e1738e7944",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-13T19:50:28.7484783+00:00",
"create_date": "2026-09-13T19:50:28.7484783+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-13T19:50:28.7484783+00:00"
}