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": "29b09844-bdbf-41c4-bb63-0b2111ceed7d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8d80f5f6-7325-43ba-8943-2de696af08f4",
"company_code": "sample string 5",
"company": {
"id": "8a97c944-1615-476d-875b-97ad96fb8e7b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-25T11:29:46.1690032+00:00",
"sales_territory_id": "0515d875-de28-4cc3-a206-5f42141c596a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "37b36417-54e3-4d8a-aba8-ded0c7c5526e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d6a5b14a-f4e3-452b-8a2f-579dd3d3ee5d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a7e7a39c-2aae-4cea-9297-ed04bde0522e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33d96e49-aa06-47b1-bc51-ba125f89845a",
"db_currency_id": "21c62e42-b633-4b61-af80-4a8da400b24b",
"db_language_id": "8c4b62b5-6af9-4e31-acef-cca798b051b8",
"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": "2025-12-25T11:29:46.1690032+00:00"
},
"modified_dateutc": "2025-12-25T11:29:46.1690032+00:00"
},
"marketing_segment_id": "a8f5816e-3c3f-458f-b0c9-e318077c2596",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1586caf8-62ab-41d0-8b9a-082a9f3fcf11",
"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": "f44dd229-b1b5-4dad-9f91-6eae048e5657",
"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": "8947a71d-0bd2-45f3-a064-763191b89aaa",
"db_country_code": "sample string 28",
"feelist_id": "1eccf874-9c3e-43b1-a961-eaeb905d39c1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "06cbc9bf-4321-4bd4-a23a-919454a8536e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "41ad6c92-aa1d-4918-8b8f-18735247f21d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-25T11:29:46.1690032+00:00",
"db_currency_id": "5879c510-51a4-46da-a8d2-32e791c957fe",
"db_currency_code": "sample string 10"
},
"company_type_id": "43aa4354-7120-4968-823f-c842f8f3e319",
"company_type_name": "sample string 32",
"company_type": {
"id": "354b1aed-216c-43a5-a4a8-95ce83a164b4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5cb501a6-be99-4589-9d39-bc6bd2bf729a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3f29f8eb-f61f-4c50-9400-f049ba76e90a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "140398d9-6733-45bc-b21f-b623e33c4fcc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4b3f8c39-0aa0-4d1f-b3e2-6621c6d1e349",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "13d8c14a-27c4-4eca-9a8c-46be0b0364d6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-25T11:29:46.1690032+00:00"
},
"company_sector_id": "f70219dd-1c54-432d-a349-56c0bb733699",
"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": "1928d8ec-108d-4e77-820e-4704dfdd1e63",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "26a0e8bc-abea-4b61-9c1d-0c4349f3bb4b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "95829eef-e615-43f2-8ff0-95ec431628b1",
"account_manager_user_code": "sample string 56",
"company_status_id": "e49bfa9e-019c-47fd-93e7-b72f6c513c81",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-25T11:29:46.1690032+00:00",
"id2": 60
},
"db_language_id": "cd625268-b676-44e9-abb8-f1219e52c8a9",
"db_language_code": "sample string 7",
"db_title_id": "29ea65c9-6112-44e1-8d3f-1c51d0c2baa7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-25T11:29:46.1690032+00:00",
"create_date": "2025-12-25T11:29:46.1690032+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": "2025-12-25T11:29:46.1690032+00:00"
}