Retrieves the company 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": "fe349ffe-2831-4af4-a791-b3856c0ebf27",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "05a378ce-e0b8-40f4-89a8-3fdeb2cdcc67",
"company_code": "sample string 5",
"company": {
"id": "2f40b7a7-89e0-42d7-a9ef-573431fecd8d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-07T06:40:44.6082408+00:00",
"sales_territory_id": "a4c1a12a-8149-453b-8c21-95470a435d45",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0cff3978-53f4-4ac2-837f-4f99d1453139",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "78dccf96-96d8-451a-8b72-0151edf9521d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5642edca-b8ff-4f4a-bf30-86a94c221599",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "443fbb42-a96e-47d1-90e8-bf5536b78f3f",
"db_currency_id": "12f67f9c-c150-47c1-b713-65aad4afda5a",
"db_language_id": "bb4e5e61-85fc-4687-b3f6-07685c877420",
"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-03-07T06:40:44.6082408+00:00"
},
"modified_dateutc": "2026-03-07T06:40:44.6082408+00:00"
},
"marketing_segment_id": "48f3a80a-c267-42c0-ad1f-f3f86e408943",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cd5251ed-0b7e-4e16-9dd8-8866629e6248",
"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": "69deaada-639f-4f1e-b361-c520f79ce8ac",
"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": "7c16d819-9598-45c8-8fa9-01419ec6c19f",
"db_country_code": "sample string 28",
"feelist_id": "4bf4c04c-c4da-4488-a924-038d538d2e5b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bb3359e3-5c5b-4bb3-908e-5c166062a273",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f310b1f7-7c7d-47c2-8239-c8f77f5da5a9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-07T06:40:44.6082408+00:00",
"db_currency_id": "024bb68a-2722-47be-a371-84a843557192",
"db_currency_code": "sample string 10"
},
"company_type_id": "5e3c820b-110e-4ce0-86c8-5f99f69e0151",
"company_type_name": "sample string 32",
"company_type": {
"id": "599f1eda-7340-4edb-8dd0-7f96cf7b9f2b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "61bfadc5-f6c4-454c-bf25-fe0ec71f92d3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f3453efe-8808-4822-90dd-8b52dfc35f6b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d8de3c6c-f7ab-46ca-af95-80dabb56ec01",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "00eb5cb3-b1a2-46f0-8c17-ddf9e265eef0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4173344d-1e1b-4381-9ee8-0257b7678c4c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-07T06:40:44.6082408+00:00"
},
"company_sector_id": "27112da4-2c1c-4ce5-a165-d7a37d7ae0ed",
"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": "dba93228-c0b0-46e5-a736-d1a9d0606a93",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "aa9fa0c4-b2f1-4a19-b731-cfdb74d01333",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5e4850bb-3022-4f6a-8287-ae324d383f77",
"account_manager_user_code": "sample string 56",
"company_status_id": "537e09c7-f820-49da-a006-f4d1aa1585d5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-07T06:40:44.6082408+00:00",
"id2": 60
},
"db_language_id": "73f8639b-4cda-4a3b-a15c-f508b4c59923",
"db_language_code": "sample string 7",
"db_title_id": "56189ff7-80d4-45cd-8c57-0168d8f03782",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-07T06:40:44.6082408+00:00",
"create_date": "2026-03-07T06:40:44.6082408+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-03-07T06:40:44.6082408+00:00"
}