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": "05487e31-fb28-4007-ab63-4a33b81dd8e9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2d62b190-f3ef-424e-b71e-295e04b30295",
"company_code": "sample string 5",
"company": {
"id": "282d9ac5-6b5b-4041-bd2c-6f9aa622fb9d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-25T02:04:26.2535176+00:00",
"sales_territory_id": "7696c4bc-8394-4525-89ef-11a8479c5fd6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e6b80875-14e5-4c2e-b516-f65cbb28c927",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8cb68293-0a4f-4749-b3be-aa9d3acf9411",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e510b9b6-7c71-4c4b-a676-f32098d7d7fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0b6fa6c2-aad6-4377-913f-c5e38e3bb9f3",
"db_currency_id": "4750c456-6055-4037-9cbe-d80355cc073c",
"db_language_id": "f507b2cf-3a61-4f9e-855e-9baf170322c4",
"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-25T02:04:26.2535176+00:00"
},
"modified_dateutc": "2026-09-25T02:04:26.2535176+00:00"
},
"marketing_segment_id": "80b6c06f-8e23-4946-9f82-2b4d4ebf1027",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5b5cea33-37b8-48fe-98b1-d83c41bbd769",
"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": "7aba72ac-005b-44da-a181-69d5c3c1e385",
"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": "b97edbe0-cd42-482a-877c-0038213b701b",
"db_country_code": "sample string 28",
"feelist_id": "a5c5066e-bf55-4f62-87e0-56f8622f8a94",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2fb89006-618f-4e30-8e5b-5577a69d2a25",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0b64ac44-8de9-4ca2-9460-e5bd93819610",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-25T02:04:26.2535176+00:00",
"db_currency_id": "15836d4d-cc41-4f1f-8e84-abb5468f0043",
"db_currency_code": "sample string 10"
},
"company_type_id": "08df7591-8b29-416d-8c2d-aba9a85b5249",
"company_type_name": "sample string 32",
"company_type": {
"id": "ab7354a8-1805-46ba-aa37-17204edd1a2a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "580ecc61-ff69-4e60-bc65-6b3bb589bb53",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8c4a0dc7-edf4-4cca-a8f4-f4dfa8cffdd9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b0c6a680-2bbe-43e7-9fe6-969d5230df1d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "821ea9b1-fd22-4ad2-9a82-4673351cff1b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1974baf6-d109-42b8-a81c-9ef775310028",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-25T02:04:26.2535176+00:00"
},
"company_sector_id": "59997d50-129d-45b7-b8a7-4d4b29a5fe42",
"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": "2eb08626-3ab3-47a2-a579-4be433834cd2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "02d4eef6-f35a-4baa-a1b2-eef0e70c38cd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "10078059-cfb2-4414-9829-4c4315944f6c",
"account_manager_user_code": "sample string 56",
"company_status_id": "50739237-867a-4056-87af-44d964d8bd6d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-25T02:04:26.2535176+00:00",
"id2": 60
},
"db_language_id": "453e81a6-eea9-4e62-b098-c82b3b58819b",
"db_language_code": "sample string 7",
"db_title_id": "a4047dd9-9037-493f-ab3a-64f88079371b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-25T02:04:26.2535176+00:00",
"create_date": "2026-09-25T02:04:26.2535176+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-25T02:04:26.2535176+00:00"
}