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": "8bc1fd09-4a36-4d48-9242-bcbd34c56300",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4dddab9e-a3ca-48f3-ae12-739b6b84c8a3",
"company_code": "sample string 5",
"company": {
"id": "d86ce9fb-d38f-48f7-a058-2cc2bd39146c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-16T01:04:26.6601922+00:00",
"sales_territory_id": "4a0294f4-5d76-434b-8cf4-ae38614bd3c7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3d111044-d34f-4637-a8a8-f18794fa067f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "25051f62-566b-428b-911f-6c1083670e20",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "09616119-4674-4aa4-a6b9-5cdd956186e7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2fedeb3a-af39-41dc-bc73-3f18593d503e",
"db_currency_id": "cde60597-5941-4a23-8b98-ca271b3975d1",
"db_language_id": "5c79066d-2abc-4b52-a2b7-cbcf7f31729c",
"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-16T01:04:26.6601922+00:00"
},
"modified_dateutc": "2026-07-16T01:04:26.6601922+00:00"
},
"marketing_segment_id": "fae38352-f86a-4170-8d19-252ede7f9551",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "56237c90-529c-4e8c-87d6-131331e7d3f3",
"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": "b147f079-0c54-410b-bca1-5a46e8c3d652",
"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": "539e6c40-41ce-4e08-8bcc-ab256b584984",
"db_country_code": "sample string 28",
"feelist_id": "29b8c04b-748f-4134-a660-5d65a60b303c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c4fda26b-6a29-46a7-aca5-08bb44d41115",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c838c307-7639-40a2-aaa5-88d5aa356cd9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-16T01:04:26.6601922+00:00",
"db_currency_id": "424857d5-d16a-4f34-ac03-50fb2db3dbcc",
"db_currency_code": "sample string 10"
},
"company_type_id": "d99821cb-19a1-48a4-b23b-952a7dbac21e",
"company_type_name": "sample string 32",
"company_type": {
"id": "31473427-eb64-433f-b714-28d795b17dcd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "88a95488-c612-48c1-a3e0-f7eb5ea94e51",
"sales_organization_code": "sample string 5"
},
"db_language_id": "92b5c196-e875-47c2-b515-24388a38b0dc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "914e1ab2-60b9-464b-8a00-71a1603c90cb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ca98efa7-0675-4be9-9b44-7d834ec25042",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b1631d9e-2e89-44ef-a033-f7599bca7a9d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-16T01:04:26.6601922+00:00"
},
"company_sector_id": "64b3c926-33c9-470e-ba03-30f55a14c150",
"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": "ce7e1da8-0f5a-49e0-8ba3-35b072ad746f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ecbdbb6e-3874-49b4-81ff-fe8ba2ffe7d6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0d3b7554-c172-4ed1-a3c4-5386d8871f17",
"account_manager_user_code": "sample string 56",
"company_status_id": "60317398-9bd2-4e7e-93be-445709f7db0d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-16T01:04:26.6601922+00:00",
"id2": 60
},
"db_language_id": "b80ec9c1-43b1-4d4d-a27a-6d0d6e519844",
"db_language_code": "sample string 7",
"db_title_id": "61bd45ad-fd81-4456-8ba1-f90e8ca88b80",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-16T01:04:26.6601922+00:00",
"create_date": "2026-07-16T01:04:26.6601922+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-16T01:04:26.6601922+00:00"
}