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": "bd660f4b-1f91-4b49-af49-77b9578fb624",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3e3d70a5-5c13-4132-b05c-aaabf229d105",
"company_code": "sample string 5",
"company": {
"id": "cd7a5e73-a2fc-4a72-8908-fe30e4b3af7c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-11T23:39:24.1570425+00:00",
"sales_territory_id": "98110b1c-caef-47a5-a4cd-cfecacac7224",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e59db139-ecbb-41f3-8100-d01f7fcf7f91",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "41e9b7d6-f58b-4792-a52f-07365bcdc837",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4903487f-a529-4458-bb25-ae23de515e81",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1636a241-9d1b-46fc-bc71-1d3b19ef290d",
"db_currency_id": "dd63160b-f489-46fa-afca-972fa7f55452",
"db_language_id": "db2d7468-da89-4334-a41b-e03995f04ea2",
"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-11T23:39:24.1570425+00:00"
},
"modified_dateutc": "2026-05-11T23:39:24.1570425+00:00"
},
"marketing_segment_id": "58df9b61-46b8-486d-8221-73d8381db031",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c42ad460-072c-4c75-bb2a-7fa0f2211f26",
"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": "1fc26e2c-2e86-482e-913d-9eae42f4f08f",
"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": "f48f10b8-b1f8-4323-a197-6c97f9029f38",
"db_country_code": "sample string 28",
"feelist_id": "ce399a62-b743-46a4-b2e4-ef8679479a6a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "292d4cd4-5fcb-45c7-b45d-6a8a6ecec53c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d7a5e1f0-c8cb-406e-8f80-f601457b1719",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-11T23:39:24.1570425+00:00",
"db_currency_id": "62d7a4ef-e264-48ad-a916-743fed9fd18e",
"db_currency_code": "sample string 10"
},
"company_type_id": "628c8c2d-89e0-4e24-b704-85039d9e2ec4",
"company_type_name": "sample string 32",
"company_type": {
"id": "ecd20570-fe20-4051-9110-25edb0019470",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "42e16b55-1d71-48b6-95d6-3a3a6b4c2d53",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4323f1b6-2d35-42d0-a894-1c7840ac0d04",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e43a3aec-d046-4b41-bdad-e264d7f95bed",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "24de5aee-d90d-456b-8fc4-26d60d074a11",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ce3963ac-38e7-4a69-85f7-a25971bcc52f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-11T23:39:24.1570425+00:00"
},
"company_sector_id": "897e2d56-bb04-48ae-a165-c650662d2ba9",
"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": "7b58ddbf-7fbd-4b60-8b7a-dfd23baa69dd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7652dc91-97d0-43ff-ade1-03f91b169ff4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5ea125ef-2339-4bbf-b8b7-706bec38c498",
"account_manager_user_code": "sample string 56",
"company_status_id": "17ae3ddb-1063-453f-b210-7067726776eb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-11T23:39:24.1570425+00:00",
"id2": 60
},
"db_language_id": "22d168fc-6e25-4390-8051-9bc27cfe32a9",
"db_language_code": "sample string 7",
"db_title_id": "036d4a93-695e-4955-bc05-378ffd2c4a8c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-11T23:39:24.1570425+00:00",
"create_date": "2026-05-11T23:39:24.1570425+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-11T23:39:24.1570425+00:00"
}