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": "d88b7543-c068-4008-98c4-c215b205bbf6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2e06cb60-09c0-4d1a-b050-82ccbe6822ae",
"company_code": "sample string 5",
"company": {
"id": "1f13a491-4bab-4078-afd6-5d1822ec0eb2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-21T15:39:08.1765116+00:00",
"sales_territory_id": "8f936c05-56e6-4d3e-98f3-256be52431b6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d6d8f184-7eaa-461e-9468-2cd13dd767e9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6bfecd8f-e268-491e-a702-74517622eebd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bd86dbce-478a-425c-a525-4715d7330a90",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d2130b8-3d36-47e8-bf94-aa7a5c9230a3",
"db_currency_id": "7276f448-e5ba-4709-80ff-c4d6c83352aa",
"db_language_id": "59bf3ae3-ad5c-4ba9-ba1c-5c91e7f99d7c",
"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-05-21T15:39:08.1765116+00:00"
},
"modified_dateutc": "2026-05-21T15:39:08.1765116+00:00"
},
"marketing_segment_id": "082017c2-7328-47c2-ac38-7a5507037ca7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ff43d19e-ea24-4201-a0e4-265467b80a8a",
"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": "b1a5456a-85f6-4312-85d4-9a2dd7ec50c5",
"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": "35c47ec5-bdca-4c58-9a34-d25577289455",
"db_country_code": "sample string 28",
"feelist_id": "f89aac67-bd4a-43aa-9366-2ee5678d5d25",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a36a713e-a24b-446e-86fe-fd09f99d3e92",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1ebbd94c-ba8c-4eb0-9414-76c1ca06c409",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-21T15:39:08.1765116+00:00",
"db_currency_id": "640a8009-2f86-47a6-a5a3-c1b09eb98241",
"db_currency_code": "sample string 10"
},
"company_type_id": "cb9f7be6-56d9-4c58-a864-77688ab2c7f0",
"company_type_name": "sample string 32",
"company_type": {
"id": "8adb5d95-3197-472f-b83f-00425e8c78f0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0e0f7688-62b3-4dbb-8d7f-da11dbfcb159",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0be0e6a4-f7a4-4dc9-bd01-c48dbd8e0ce3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cabd4837-76da-43e4-a316-77c1434ec05c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "177e5779-d14d-405c-b0e3-80124b39b548",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7e15f96b-4f13-42f1-bedb-b68cb212fad7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-21T15:39:08.1765116+00:00"
},
"company_sector_id": "e30beea7-a835-462f-a63a-63416bf613d5",
"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": "53ea9ebf-a88a-4dcb-83d5-fc773bf68388",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0e66422e-bf43-4c50-b299-f81663924e9e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0dfcde00-263f-478b-a5a2-a067bf09772e",
"account_manager_user_code": "sample string 56",
"company_status_id": "804bc1b4-5a93-48c5-9c81-41ca23aece0e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-21T15:39:08.1765116+00:00",
"id2": 60
},
"db_language_id": "dbd934e9-e3cb-4e47-9c59-6abe2d79e248",
"db_language_code": "sample string 7",
"db_title_id": "b6f5176b-2ce9-44b0-9ce8-91d6d0bb696f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-21T15:39:08.1765116+00:00",
"create_date": "2026-05-21T15:39:08.1765116+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-05-21T15:39:08.1765116+00:00"
}