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": "c723e2d5-3675-4244-9af8-a8ed6b66a5c7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "af9da771-e9a4-46d5-90e5-a78138150408",
"company_code": "sample string 5",
"company": {
"id": "b4f42fef-a7a0-4371-b446-4bed13f96e6a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-25T04:33:55.7802358+00:00",
"sales_territory_id": "1b34e79a-d826-403b-bb48-c503bc440479",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fefac383-5c9e-434f-a409-a0c8c62c78ad",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1651c3ae-265d-4edf-b3e5-94bf4c575437",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2636832a-67d5-4ff8-98fb-27769b604856",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13cfd046-41f3-4860-b840-60c628a4da4b",
"db_currency_id": "f2459179-be36-429a-95ca-0270d819062a",
"db_language_id": "53e015f8-53dd-464e-bf5f-2836038826e2",
"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-06-25T04:33:55.7958607+00:00"
},
"modified_dateutc": "2026-06-25T04:33:55.7958607+00:00"
},
"marketing_segment_id": "360802d5-9b6c-47da-ba38-acf040b1cea1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c19f4bc4-4ce0-45a3-9fda-3975a92c27b1",
"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": "cd8b4067-df45-4ce0-b059-a85193095bc2",
"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": "f71ae152-2dd4-4288-b290-6cdd1601c3f5",
"db_country_code": "sample string 28",
"feelist_id": "cdcf64e8-106d-43a0-8f69-6e90afaf9e97",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3a8d4d37-551b-420e-ba98-fa40ccd5ffce",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5df4a36c-0f42-4970-a8d1-d21de0c9274f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-25T04:33:55.7958607+00:00",
"db_currency_id": "92609f86-667f-466b-8f38-af4a8c2f8d2d",
"db_currency_code": "sample string 10"
},
"company_type_id": "f9547bdd-1fe9-461d-857e-fbcb6d66ba86",
"company_type_name": "sample string 32",
"company_type": {
"id": "05a61217-9e8f-4109-84d7-eb5995f625c8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "df9ed1bf-a250-41ec-822c-9fcfc259d767",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e71020c9-dfa0-4a7f-b441-f2449c8b9b0f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "aa65fd65-5efd-44d5-8f01-0f2492395e2d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9861f490-3d71-463a-99a4-9b45e1cb776f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bc7fdeb0-e5ec-4f13-9330-24231333ef35",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-25T04:33:55.7958607+00:00"
},
"company_sector_id": "2e0d8436-af46-4347-b4ff-6fb17279afa3",
"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": "c8ae438a-5521-47a9-a36c-78f0b1de2c59",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0c02a513-fdd3-4305-9ade-03860633d5cd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5b9c5241-5537-4894-9301-7ce4cdae7480",
"account_manager_user_code": "sample string 56",
"company_status_id": "58eb8e48-351a-4944-9688-ff1cff012917",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-25T04:33:55.7958607+00:00",
"id2": 60
},
"db_language_id": "bda517bc-869a-4567-a94c-22d923190e85",
"db_language_code": "sample string 7",
"db_title_id": "567723a4-0509-4059-9f9e-44ed87e2881c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-25T04:33:55.7958607+00:00",
"create_date": "2026-06-25T04:33:55.7958607+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-06-25T04:33:55.7958607+00:00"
}