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": "adf96ab3-746d-4eb6-af9b-4edc745d8833",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "97ff28ff-0ab4-45e0-801a-09a1d18e1082",
"company_code": "sample string 5",
"company": {
"id": "4ac6ec96-7be4-4ed5-82b7-101760e0a54d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-11T11:03:37.3272899+00:00",
"sales_territory_id": "f1593135-59e8-4450-bf8f-2deb576b6ea9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0721861e-3a34-484b-a738-d365c2146866",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "45375690-f7e4-4b50-a8e7-ba3ff8b37815",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4eed3d07-700b-44e2-99be-d99e3aebaeeb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b53081a6-09e3-4c61-bd09-596da55bdd64",
"db_currency_id": "bc7ce0fd-bcbf-4419-b6b7-4c6639abb23c",
"db_language_id": "997b449e-085b-41fd-a86b-b7d004b62675",
"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-10-11T11:03:37.3272899+00:00"
},
"modified_dateutc": "2026-10-11T11:03:37.3272899+00:00"
},
"marketing_segment_id": "74fd6ed2-ae60-4a02-a83b-455838c761a2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e5c8f1ac-89ab-4efe-9986-9b9c8a016de9",
"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": "4b761f37-0b88-4a1b-b05e-9d5c8efc7ac1",
"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": "935e80ca-322f-4313-ad7a-936134cd280c",
"db_country_code": "sample string 28",
"feelist_id": "920fa136-3602-495d-8878-0dd0a498ad5c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "15e3b3c8-ad53-49fc-8eb1-38f67caadf6e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b057c4f2-0387-42ae-ab65-eff6ac535676",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-11T11:03:37.3376761+00:00",
"db_currency_id": "ae83febb-5b3e-4c9e-87e5-e547eadc49b4",
"db_currency_code": "sample string 10"
},
"company_type_id": "bb729f85-d1df-41f6-b821-56ac3092ee82",
"company_type_name": "sample string 32",
"company_type": {
"id": "4ac8fa6a-0ccb-49a3-96d6-dfdb5815621d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cd12ecc4-098f-44d1-975d-62fda3a215bc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4195c32e-6f35-440b-b9b3-92a466f8d041",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c06863f8-4294-4674-ac44-23a5dd8b19c1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6019c555-0ea5-4bb1-a597-63e5c33eda7f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fb0cc619-5550-4afb-960a-2899eedeb816",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-11T11:03:37.3376761+00:00"
},
"company_sector_id": "ce2d6492-8ec1-415f-8016-a22fd012a834",
"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": "7a78bab5-b081-4a88-9c9a-f61dbbe70a98",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2cd801bb-c286-493c-b751-de90e4555e50",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f0509a95-b2b5-4e9b-98e5-aec69eaa7038",
"account_manager_user_code": "sample string 56",
"company_status_id": "28ce2b2b-17c9-4bd8-9d5c-d65a17f489a3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-11T11:03:37.3376761+00:00",
"id2": 60
},
"db_language_id": "9cb02e51-4789-4acf-b1fb-5c801e1ebf56",
"db_language_code": "sample string 7",
"db_title_id": "c6b688a8-c610-4449-8576-73b700c30f64",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-11T11:03:37.3376761+00:00",
"create_date": "2026-10-11T11:03:37.3376761+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-10-11T11:03:37.3376761+00:00"
}