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": "c5b1bd20-189e-4cea-8535-68fcd7ec0917",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "73c98704-0459-4ff2-8e96-4957bf1bc9b1",
"company_code": "sample string 5",
"company": {
"id": "bcb59b2f-a8ba-4ba4-9de5-be2098cc8794",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-26T10:14:51.4367888+00:00",
"sales_territory_id": "d8957f7b-c7f3-4bc6-96de-7ac405781155",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "399f5bc9-b0b8-4892-ba34-e99b2fc02c9b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8ecc445b-dbd1-4e0f-bd72-bcea61e15921",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1b71974c-27c2-4d26-ba96-215fe7d1dc66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b90e4aec-9e17-4c49-a3aa-11c5eb009f64",
"db_currency_id": "0837f5ac-cf1a-4c23-ae26-f011ea9dc1dd",
"db_language_id": "35c14495-a737-4cb4-a550-bb5a1f73469c",
"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-01-26T10:14:51.4367888+00:00"
},
"modified_dateutc": "2026-01-26T10:14:51.4367888+00:00"
},
"marketing_segment_id": "3691babf-ed64-44a3-8cb5-3767c8ce1dd5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0c880a9f-9ccd-41fc-8f01-2e3c2707b36d",
"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": "2b51aaed-0242-4769-9f35-3885c6b41d34",
"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": "78633b64-27f1-435a-90e2-6e6e34edf161",
"db_country_code": "sample string 28",
"feelist_id": "84c7daeb-59f2-486d-a354-882f022550fd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "96795032-50fb-4670-829b-653bd9c7f432",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "28b4b348-4c69-46d8-923e-863670ed95ba",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-26T10:14:51.4367888+00:00",
"db_currency_id": "6a309b1d-e7d3-4f16-bd27-a68d8df9ea16",
"db_currency_code": "sample string 10"
},
"company_type_id": "5f4e78d8-e18d-4be9-9927-e7e40c79037a",
"company_type_name": "sample string 32",
"company_type": {
"id": "ed457f12-9be4-4521-a136-0472addc658a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d42d6eca-e998-4209-84d1-f31e73d2d81d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c9bb3eb5-4a27-4b21-acd9-0a4313346e48",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "24292d2c-6ac3-4118-8228-c0c6903f4999",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "68bf9e09-bbf5-4dcd-b7ee-5c41503d33ad",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "93249c39-0aad-4e47-8d88-16f76ba471cf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-26T10:14:51.4367888+00:00"
},
"company_sector_id": "6b5eed9a-eaad-4b50-b442-da9df3699e40",
"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": "15d200d3-8010-4ac5-8d18-3326f27155ba",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5776306a-868d-453e-83e1-36dfb6ba6fec",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3214c859-e8e8-44e0-b6ab-1251a05ab831",
"account_manager_user_code": "sample string 56",
"company_status_id": "52f56127-b4b1-4192-81c4-2643f7983f6e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-26T10:14:51.4367888+00:00",
"id2": 60
},
"db_language_id": "556909c2-a9e9-46aa-b508-6282f0833a0c",
"db_language_code": "sample string 7",
"db_title_id": "a27a1834-98f7-442a-859c-9a853cf3cf8e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-26T10:14:51.4367888+00:00",
"create_date": "2026-01-26T10:14:51.4367888+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-01-26T10:14:51.4367888+00:00"
}