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": "6bf12feb-8f87-4578-a63c-0d1be6b68032",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f5fe586b-b773-4ab8-ac95-5e86bc318bc0",
"company_code": "sample string 5",
"company": {
"id": "194511cc-fcb1-443b-9532-862bfac8a3b8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-09T02:24:48.6227341+00:00",
"sales_territory_id": "48815213-7fb2-4e2b-a30d-70dbcf06a2b4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "21f621b0-f21c-456f-9d2b-053489d59f7c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a924d4e-1ab8-4157-8fd6-596009bc9660",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b9a883f5-84eb-4a59-8a06-d151ca27652b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a45ce6b1-4cd0-4ccd-9501-bb2b5ab4a8ee",
"db_currency_id": "6e7c4de6-096d-4119-8f8d-a12be63cac45",
"db_language_id": "53898166-8175-4bf1-9347-6c647b6db1ab",
"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-09T02:24:48.6227341+00:00"
},
"modified_dateutc": "2026-07-09T02:24:48.6227341+00:00"
},
"marketing_segment_id": "4a5cb8ab-be73-4d4f-95e7-c8763be2a2b3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f9776dd6-73be-476a-86ce-697a82ca7e7c",
"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": "370e213a-82ac-4e7b-b901-cfbc23a67d32",
"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": "26861e65-e33c-4ee0-9e27-9897bd2354b5",
"db_country_code": "sample string 28",
"feelist_id": "e1dab067-3db2-4b43-a868-5c86ce49ffe6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "72b8bdb3-4865-40a4-ac15-08545f1d7c95",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4ab4a625-0fd3-491c-a9db-ffdbd6c6dc4e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-09T02:24:48.6227341+00:00",
"db_currency_id": "92d4edaa-2079-4dcc-b397-f9fcf00e3fde",
"db_currency_code": "sample string 10"
},
"company_type_id": "29a5c641-34c1-4d44-8dbe-fee91ab81626",
"company_type_name": "sample string 32",
"company_type": {
"id": "1b45aab7-b111-4814-a503-9b6dd10cdfbb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "58f52c06-84fc-4872-bd1b-cdc1536309aa",
"sales_organization_code": "sample string 5"
},
"db_language_id": "18f78375-5e01-481f-ae36-0e9c599bf997",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "df18f06a-728a-45bd-8861-815cbbf68054",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b293bcbf-fd9d-406c-8a16-98d74f7f47c5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "94b73ef2-ce2b-4429-b082-2a03ce9b2bf9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-09T02:24:48.6227341+00:00"
},
"company_sector_id": "5aeadc33-d23a-438d-b639-cd91cf4dfbc0",
"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": "447798a8-fa12-4db0-80d3-2ae9ec6f6521",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5e871c94-643d-4c16-9432-f9fa268f75fc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2ff83a7d-b621-45a6-81bc-bf739efe5545",
"account_manager_user_code": "sample string 56",
"company_status_id": "15a69fdc-c2ec-4eb9-a980-da53703c5526",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-09T02:24:48.6227341+00:00",
"id2": 60
},
"db_language_id": "551a4666-a9fd-42d6-af33-4988cc4084eb",
"db_language_code": "sample string 7",
"db_title_id": "02e48d86-b855-438d-a44a-824aeed8e542",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-09T02:24:48.6227341+00:00",
"create_date": "2026-07-09T02:24:48.6227341+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-09T02:24:48.6227341+00:00"
}