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": "80b6aa84-0ee7-4cf9-bd27-4599d3277ba7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "badaaf1c-7d63-4a69-9493-2ece378bf6f6",
"company_code": "sample string 5",
"company": {
"id": "50e6dc61-c12e-4504-8007-9f78f1866d64",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-18T13:36:30.637069+00:00",
"sales_territory_id": "1081e09f-e816-4751-85cc-d0e50bdbf728",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2ec69fc2-ecbf-4c95-8e79-7da9dd7c570d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "05e5ff56-2123-4efc-b11a-c5ed23320d81",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7b866cdb-cb70-4917-af27-7744cbcf317a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff0e3cc4-8d48-4e3a-bdb9-a4d78b935ceb",
"db_currency_id": "b82a8388-7a9b-43c3-89ae-dd5ccf1928aa",
"db_language_id": "f70f32eb-5c62-4d64-88aa-ed6e112417f8",
"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": "2025-12-18T13:36:30.637069+00:00"
},
"modified_dateutc": "2025-12-18T13:36:30.637069+00:00"
},
"marketing_segment_id": "be4d8f6f-b6b0-47a4-b620-5710eb897bcb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c1c4bd68-bfea-450d-b396-33b9d380708a",
"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": "b664ffeb-f365-478f-8080-fef105f10b86",
"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": "ca31625b-3219-455a-8c73-8d1c5d607fdc",
"db_country_code": "sample string 28",
"feelist_id": "ad8fc0d4-cadb-423c-b679-b3c9fff18374",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1bae0092-3ca7-4c57-aa81-66b7c06765a8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "093427df-0527-49b2-a033-1bb38758da07",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-18T13:36:30.637069+00:00",
"db_currency_id": "2256385d-6249-4bf2-ba35-56ccd568d756",
"db_currency_code": "sample string 10"
},
"company_type_id": "d32699a3-d012-4897-acb8-438d504c1ed1",
"company_type_name": "sample string 32",
"company_type": {
"id": "cde9aa35-44ad-40b4-96d6-bbabbd757c2b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a7c1a0a5-78c4-46f5-8e3a-afffd5442a6d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "68b12ce9-4c15-4a05-8d9f-b480891084a3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "737f6328-9038-4f54-a2f7-a8ae56f3d249",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6c1e3eed-a897-4c39-8785-507b7ff13109",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a2128042-3992-4ddc-894e-10b7e666417e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-18T13:36:30.637069+00:00"
},
"company_sector_id": "d542d9b1-9d3d-451a-8b1e-5c1abfece829",
"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": "1f61114f-ef04-42c8-9d9f-a4d398abefa0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "58f4b30e-b0e7-409d-b5d2-8304e5e5f740",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c63472c8-2465-4529-a124-18cc54613439",
"account_manager_user_code": "sample string 56",
"company_status_id": "d58b059e-0cec-45ff-901f-e0f639c56aa0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-18T13:36:30.637069+00:00",
"id2": 60
},
"db_language_id": "d938ce3c-9f62-40dc-aeb4-bfb8573c6472",
"db_language_code": "sample string 7",
"db_title_id": "d4332fa9-5b8c-4f8b-9e92-e66ef3101d54",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-18T13:36:30.637069+00:00",
"create_date": "2025-12-18T13:36:30.637069+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": "2025-12-18T13:36:30.637069+00:00"
}