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": "0ccd21af-e3d0-4a49-b492-4e063d360da8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5ac9adcb-5258-4f27-bbbe-8165c0d58bb5",
"company_code": "sample string 5",
"company": {
"id": "eeea4035-bb8a-4b92-bf0f-99f65e10644a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-29T21:34:18.6708685+00:00",
"sales_territory_id": "cc5f84d8-ab4d-4326-b94a-c59e42999703",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2e18ea31-66e4-4534-ad4d-4854e708710b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1b65ff8f-ab9d-4fba-b3f4-4275e23f5bd8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5a60c1ba-d5dc-46ca-9228-1762f5240a1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d01723f5-3a04-4572-a2ea-7f27e9ac7c1b",
"db_currency_id": "7eb8e5cf-3e57-4b3b-b3b7-4b1e95f7ad56",
"db_language_id": "3b2995f3-d989-4dd5-964b-558b81ac3270",
"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-29T21:34:18.6708685+00:00"
},
"modified_dateutc": "2025-12-29T21:34:18.6708685+00:00"
},
"marketing_segment_id": "eb7e21ca-948b-49ea-b8a6-43e8ed9cf666",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "135b8f9f-28ff-44dc-ad8f-6f19c59de0cb",
"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": "e81bf24f-c1e2-457a-908a-15ca7839b22c",
"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": "3bccf489-faae-47a9-9446-622106d8a74e",
"db_country_code": "sample string 28",
"feelist_id": "c87d7535-75e8-4038-851f-cb39503f3903",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "78fc387c-3fed-4b05-967d-f21c97d52e60",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7d8c585a-7f9d-45c4-8a49-39769b643509",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-29T21:34:18.6865053+00:00",
"db_currency_id": "27a62c7c-60e7-434d-91e4-0a44f6eaa64d",
"db_currency_code": "sample string 10"
},
"company_type_id": "6db97b7f-7314-4952-b350-44e2dcc98e41",
"company_type_name": "sample string 32",
"company_type": {
"id": "e5f43625-bc7c-4e4e-ad42-7734d317e556",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b6ee78fb-b192-430b-9768-5789a7a2fea6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5841ef89-b489-4bd2-b7ef-59bd502676cd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "86dcc13f-c762-4249-a1c6-63128fe7ed5f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fc253eb4-d8af-4f3a-8627-fe15360e327b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3642b506-85ef-42d0-9470-8ea2fc56af14",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-29T21:34:18.6865053+00:00"
},
"company_sector_id": "c3fad4cd-d25a-4df5-b85a-642a1905755f",
"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": "2b138e57-1be9-4b7f-8054-c48b92a61027",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f499498d-0194-45f9-afe9-db43d0310bf8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fad72436-921a-44be-acde-5d7fe2211a30",
"account_manager_user_code": "sample string 56",
"company_status_id": "718422fc-6e27-4169-b926-8491ef136884",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-29T21:34:18.6865053+00:00",
"id2": 60
},
"db_language_id": "b6dfdfa2-efaf-48ca-802f-f0779e147931",
"db_language_code": "sample string 7",
"db_title_id": "2d3a2d1a-840d-4177-aaf3-b65c1dff21c1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-29T21:34:18.6865053+00:00",
"create_date": "2025-12-29T21:34:18.6865053+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-29T21:34:18.6865053+00:00"
}