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": "1dbd523c-6f8e-4b6c-92d3-bb092e67814f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1517086f-6f35-426f-9474-62280f5657b3",
"company_code": "sample string 5",
"company": {
"id": "f0151952-40a0-4ab7-ae2e-c46dda4bebd3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-17T22:48:41.2206846+00:00",
"sales_territory_id": "77b39098-6f24-43f5-b096-08048946fdcd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d001b2dc-5444-4488-9e76-46a876520f51",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "689c1e51-bb4f-4d6a-acf8-b6b308195ce9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c6a6ace8-1535-4784-a9e7-68dc3644303c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57d02abb-0f90-47c7-b0cd-2596a4a0015b",
"db_currency_id": "e20e06d2-af9d-4839-b2dc-d6d58dc2d844",
"db_language_id": "db29d08e-1d1f-4000-9763-ef14cf794e23",
"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-17T22:48:41.2206846+00:00"
},
"modified_dateutc": "2026-09-17T22:48:41.2206846+00:00"
},
"marketing_segment_id": "81a2662c-5f93-46f8-89de-756d3b1012c6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ed967272-946e-452f-9e2f-cb3ec11bc1e1",
"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": "1f2cbf4d-41e2-47d4-8b8e-28cdb0cbda8f",
"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": "6eab342a-365a-4db5-88c2-97c23fb47948",
"db_country_code": "sample string 28",
"feelist_id": "66985a6a-a065-4440-985c-ca43dda508dc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "620f9e26-eb81-42a1-84c5-a5aa915ae31a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "64d7ce03-75e2-4b3d-89b9-afe2d349ee4e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-17T22:48:41.2206846+00:00",
"db_currency_id": "4cc48fc3-0e1c-463f-b3b3-2f5a015bf770",
"db_currency_code": "sample string 10"
},
"company_type_id": "9621a679-0bfe-4078-b4aa-37c06b02f32b",
"company_type_name": "sample string 32",
"company_type": {
"id": "35162535-6163-4c9f-9f14-6761b67242f5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "93b699ae-ddea-44a8-a784-816b831bc75b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6cc5b744-9be4-4eee-a243-cec1d37316f0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9315687c-a08e-40e6-a13f-41b8fc3ec9eb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8d6b1d8f-3bd5-4815-8690-5fb7ed37eb65",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "52660639-a478-4b1d-a11c-4d2615e1eafe",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-17T22:48:41.2206846+00:00"
},
"company_sector_id": "cf3b0346-f994-49de-be7e-06f0bccea7e8",
"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": "9b9ef297-33d2-4fe1-b3ab-c0bd8c58ff00",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "39b8b0e9-ba00-4998-bf65-b934375e3780",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5f6c8814-0557-404d-b828-ea74e02e5a10",
"account_manager_user_code": "sample string 56",
"company_status_id": "7b04765d-ebc3-4797-b8e2-cf41917ea59f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-17T22:48:41.2206846+00:00",
"id2": 60
},
"db_language_id": "76a666c7-9d9f-41c5-a8c6-424f4cc12911",
"db_language_code": "sample string 7",
"db_title_id": "35f759f7-9f41-4f0f-a5cc-0cccdef22096",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-17T22:48:41.2206846+00:00",
"create_date": "2026-09-17T22:48:41.2206846+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-17T22:48:41.2206846+00:00"
}