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": "0c712024-645c-44cf-bc61-f56c664eb8f7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d4972afb-71bd-4384-8a6f-b0e7feef0ed8",
"company_code": "sample string 5",
"company": {
"id": "381f7a8e-a9bc-4812-a9bd-f4e18abfea6c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-23T09:55:45.6978105+00:00",
"sales_territory_id": "e3ba3cca-0c93-4566-839d-12850b4e02d7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a092aa33-c519-43d5-a215-67b95f0b1d0c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "74e89c77-e2cd-410e-9ce0-8182dbcc666d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cc9a58b1-c905-4525-87cc-8bc333f2a032",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "503632cc-e6fe-4c03-a5b1-2b508e959fe6",
"db_currency_id": "c7788713-9833-4d9e-9888-597ae3e3bc32",
"db_language_id": "f0e47338-3aa9-4880-80e4-478d5d76f3e5",
"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-23T09:55:45.6978105+00:00"
},
"modified_dateutc": "2026-05-23T09:55:45.6978105+00:00"
},
"marketing_segment_id": "ba0e313c-be3d-4147-acd1-6a107b6c2e5a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a8e3b79b-86f9-4c30-83d0-0537ca15893b",
"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": "0f31c88c-3eab-4b88-896b-c34fd7f23696",
"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": "df9858a0-935e-4662-925c-9eb71e47813f",
"db_country_code": "sample string 28",
"feelist_id": "289730d8-658d-4be3-a0fe-8be010b94bec",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e2f6dc6f-d27a-42cc-92b6-7776a41b75cc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "740274f0-0b31-4d60-81ce-90b3f42d2a6a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-23T09:55:45.6978105+00:00",
"db_currency_id": "d0b3de4d-2f8c-403f-b3bf-eec4c9603693",
"db_currency_code": "sample string 10"
},
"company_type_id": "93129ac3-cd4e-45ce-b6b7-59bf35fd3b15",
"company_type_name": "sample string 32",
"company_type": {
"id": "a09c83c1-9098-4e3f-accb-fbc28562cf63",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cfbf99eb-28eb-448b-9c41-f38604f4aede",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ce376129-3ba0-47d0-bb60-c5e4fa4ce126",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3e16bcd7-2909-4838-ab7b-6c4fcc27cd8e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "80cc367c-e37d-4305-bfcd-62b234e6f746",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e30316ce-e660-4860-8a61-6a4da028d034",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-23T09:55:45.6978105+00:00"
},
"company_sector_id": "b983b10a-72b7-478f-9f56-370108f50d41",
"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": "d1a43a9d-422c-4a1c-b1e1-e434dcffb2a9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fc5db2ed-48e4-46ed-b094-c76a3389963a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b8559e45-aa76-40e9-8453-5615172a3b13",
"account_manager_user_code": "sample string 56",
"company_status_id": "90e14535-acf0-4790-a3d9-d399f1423a98",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-23T09:55:45.6978105+00:00",
"id2": 60
},
"db_language_id": "84d7c46f-6fd6-428f-84ac-8638b6e4e1ef",
"db_language_code": "sample string 7",
"db_title_id": "9fa7637c-5ac9-4692-867e-9c5d16a86701",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-23T09:55:45.6978105+00:00",
"create_date": "2026-05-23T09:55:45.6978105+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-23T09:55:45.6978105+00:00"
}