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": "1737327d-5b05-41dc-9b01-4ef9e20d3139",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "74d16a85-fd5d-4ff1-9485-93b87ba64e26",
"company_code": "sample string 5",
"company": {
"id": "50dd1a74-5970-4b10-bd1f-25518dfef69e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-07T20:54:04.6203853+00:00",
"sales_territory_id": "f2db326e-27fb-40bf-92e5-8272e44caf15",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f2c5d581-4578-410a-97d5-17d51fc9dab6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6c77c6a4-bc39-4516-b0b3-a9dcbf38c800",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b2ed3311-b187-4f5b-8f96-461c01f38c29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59da8cf3-faae-4b51-93e9-b5fa8cc698b6",
"db_currency_id": "0085f404-de49-457f-906b-0e4557bf6e80",
"db_language_id": "bd0ffe2b-ae4a-41a2-89c4-a4719ba59751",
"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-07T20:54:04.6203853+00:00"
},
"modified_dateutc": "2026-05-07T20:54:04.6203853+00:00"
},
"marketing_segment_id": "340e95eb-d89a-468b-8fe2-20dfc48537de",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5da7a76b-5158-4fdd-bf7f-108be0c9f099",
"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": "2801aced-1edb-465f-977b-8295237d81d9",
"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": "bdbe5811-f07c-4757-ae2d-a57a634f722d",
"db_country_code": "sample string 28",
"feelist_id": "4daa904b-64d3-48aa-9510-7872d1c1cbc5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1e1e48a0-051e-494f-8c88-49c7644470b9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4b5e35e9-e858-40ef-8c17-3ffe7c9046b7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-07T20:54:04.6203853+00:00",
"db_currency_id": "219ce613-d505-4b3d-a313-aca8632e21ae",
"db_currency_code": "sample string 10"
},
"company_type_id": "945ad511-7db0-4ef5-a3a7-a549e3ef6f62",
"company_type_name": "sample string 32",
"company_type": {
"id": "7ee29386-943b-4bd4-9708-7723a7788a3f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1dfaabe6-0c2c-485c-b8c2-533af2fc48ec",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e37ed094-e5c2-4764-94e5-b432551a48d2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c944ec80-baf5-4401-8a96-93a8099a6f05",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cdda5de6-abaf-4e67-a0e0-0d27f879238e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bab6b4e4-4162-4e23-8839-bb1a7f02f47c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-07T20:54:04.6203853+00:00"
},
"company_sector_id": "0fb51331-0709-4c03-a60d-bf450d0201d5",
"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": "79254305-ff94-4151-bf20-f02f7e974765",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "85b79064-2f51-429f-913f-6fcc9bd78f58",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d3630d2d-63b5-468b-a78e-aedd80dd8067",
"account_manager_user_code": "sample string 56",
"company_status_id": "a6f39bdc-e5dd-4778-b143-a2da1217609d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-07T20:54:04.6203853+00:00",
"id2": 60
},
"db_language_id": "13bd647c-68cc-4052-a507-5d4e1fff343b",
"db_language_code": "sample string 7",
"db_title_id": "8b10859c-f192-4c13-bd2b-cdbb4fcd31f2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-07T20:54:04.6203853+00:00",
"create_date": "2026-05-07T20:54:04.6203853+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-07T20:54:04.6203853+00:00"
}