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": "ad42d971-2ae1-4afc-8476-2d0544857d33",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ce58e43b-a0d5-4cf9-8abd-cf140f005ef1",
"company_code": "sample string 5",
"company": {
"id": "305f8024-92df-4649-95d9-281122be98bd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-06T02:47:33.2732975+00:00",
"sales_territory_id": "5f8ac2f9-a008-4e45-b466-132f1142e2b5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "05acab0b-aeb2-47c6-bdd3-ed6d7087407c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "36a6b7b1-886f-4c99-bf62-bfa6f5b56e42",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "07041bcd-0503-41e5-80c5-dc014a296fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85da7358-c3a1-4c7a-a6d0-979da5aa9605",
"db_currency_id": "435bc872-a8e9-4512-a468-286ed6b9e1e7",
"db_language_id": "233578e8-6eb8-40dc-ae96-f6f588d53323",
"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-07-06T02:47:33.2732975+00:00"
},
"modified_dateutc": "2026-07-06T02:47:33.2732975+00:00"
},
"marketing_segment_id": "ccafde4e-e866-43fe-bf59-04a0e32ec5f8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cff9f9ba-f7e2-46ce-b00f-c055d44eff6e",
"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": "337b11a1-d49d-495b-850e-c2b8a8bdfba6",
"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": "6df0e21a-7b34-4bfa-83ec-1bc1925cefb2",
"db_country_code": "sample string 28",
"feelist_id": "818ae1f1-d362-4218-a49d-6028ea37fc07",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4951da0e-a0d4-4f96-bd65-f83ed8f136ad",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "db6a7631-8354-4959-9f6e-005e85990945",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-06T02:47:33.2732975+00:00",
"db_currency_id": "8a7499ae-9f16-4216-ba8b-46007a9829e4",
"db_currency_code": "sample string 10"
},
"company_type_id": "58ae885d-1403-4684-b5c5-f44d7f555267",
"company_type_name": "sample string 32",
"company_type": {
"id": "dd13bff5-1476-4d3e-bdfe-cbe75d8e6d2c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8ae743f0-8fb8-49fe-aacd-475585c434a3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a118f8f3-56f9-4863-9b93-6369b85291d8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "efdfae43-6f15-43a1-afcb-3812653b2cc7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b3b4910a-6bb8-4a27-8c36-1dbd7c0737e6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "51f9b736-bf3d-4ca3-a2a6-4288d35b7708",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-06T02:47:33.2732975+00:00"
},
"company_sector_id": "4edbb658-9904-4857-8f6d-1d47f7c902dc",
"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": "b70d2f5b-2307-42ea-b137-9f4b1f28f4cb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "94b06d04-a7cb-48ab-99ff-a3fabfd00643",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1287c356-edbe-45ea-8e5a-b45652372efa",
"account_manager_user_code": "sample string 56",
"company_status_id": "06dc57c5-0c16-40c6-b828-b9b77f86a4eb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-06T02:47:33.2732975+00:00",
"id2": 60
},
"db_language_id": "5ffd94a7-14d1-491e-8c0a-62f422195784",
"db_language_code": "sample string 7",
"db_title_id": "a2f977c0-004d-4623-a860-82d8f6fa71f0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-06T02:47:33.2732975+00:00",
"create_date": "2026-07-06T02:47:33.2732975+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-07-06T02:47:33.2732975+00:00"
}