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": "30ea7d5a-7d85-4ecb-ad60-97fb07ae43ed",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c375ddb4-f45a-4f31-9f4a-6d3e3024b202",
"company_code": "sample string 5",
"company": {
"id": "e3b845f6-e8e0-41b6-96f4-b826caf241f4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-27T14:02:45.348486+00:00",
"sales_territory_id": "39635b8c-d9c4-4fcc-bbb2-cdc76e2d434d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0a9e6448-a8cb-4ff0-a4ff-9b2e3fbeb2cd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "717b8651-2b6f-4369-8f1f-0845e40f513c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9c235f15-9663-4142-8495-77106e907845",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b864e7f0-a18f-4b00-8580-1d9607e91743",
"db_currency_id": "e9411b44-f6e2-498e-9095-8dc18ed3c0b7",
"db_language_id": "02819840-0cd3-4e4b-bab8-a1897268763a",
"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-27T14:02:45.348486+00:00"
},
"modified_dateutc": "2026-07-27T14:02:45.348486+00:00"
},
"marketing_segment_id": "f611c0dc-d6d1-45af-a321-f22bd5a9b492",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "837323d0-3d2e-4391-8755-83d8ec7e7ee4",
"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": "9c2d8293-9a9b-4a8b-af21-dd86a9b8a0c2",
"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": "0f6af986-30a6-49f0-866e-57e6366e1882",
"db_country_code": "sample string 28",
"feelist_id": "f2066550-bc6c-4fb9-9538-47be28a9690b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "30d9110d-e941-4b2a-ab8b-1fb779524b44",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f8d83e3c-42b7-4d2a-831b-2da0b6d74547",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-27T14:02:45.348486+00:00",
"db_currency_id": "df509b17-0920-4ddb-a2c8-8438b8d3faaf",
"db_currency_code": "sample string 10"
},
"company_type_id": "d6a45ac1-291c-415a-a6bd-fb200b71cef8",
"company_type_name": "sample string 32",
"company_type": {
"id": "df9f2eef-6f2e-483c-9e6b-f77c469c5ae4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3a5898b0-56af-4832-b995-f977c36deda8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2437b64c-ea17-4962-a57d-d0344578ae2f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f62d0546-1f36-4c37-a59a-95bfa94f6bac",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dcf0b782-1e61-4f09-b41f-865016ecb76f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "70f237fa-21b8-4d7a-9ade-21a1db630ea9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-27T14:02:45.348486+00:00"
},
"company_sector_id": "a70715b6-5971-47a8-aa3f-2cb174fdf3ea",
"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": "3293f1ad-173c-4986-87e0-689d0b7886fb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "722504b4-0933-48cf-be82-c01ff239923f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "90d9176a-330a-42a8-a351-34569eec70db",
"account_manager_user_code": "sample string 56",
"company_status_id": "58f633be-7274-4134-83aa-fef96c7063c0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-27T14:02:45.348486+00:00",
"id2": 60
},
"db_language_id": "27a00fb7-8c82-46e1-ba6c-44d14da7883a",
"db_language_code": "sample string 7",
"db_title_id": "80b57a3e-55ea-4254-bf04-f3bca972dc97",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-27T14:02:45.348486+00:00",
"create_date": "2026-07-27T14:02:45.348486+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-27T14:02:45.348486+00:00"
}