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": "d846a3ba-e3a2-4951-bcec-5b8fc68235a7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7887183c-97d4-445f-b44a-3847e580bf06",
"company_code": "sample string 5",
"company": {
"id": "29f87e28-3bc7-417b-879f-d60a53904c29",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-11T12:55:43.928537+00:00",
"sales_territory_id": "20a83692-c16a-4e2c-908a-dfd6ad620a46",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2ef36c7e-94c3-4c0b-b80a-f3b27e2eb7d4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "24789dce-aadf-4200-a6f3-134aa1400ab2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "933bcade-8b63-4c2e-bcdd-cb31c8da4264",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a807f50d-19ec-42b9-b85d-5e18e5d31c36",
"db_currency_id": "c587a7c1-3c7c-4e0c-9c31-3da2e37a0c59",
"db_language_id": "a57287f2-a6de-438f-a2dd-dbbea6917d13",
"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-11T12:55:43.928537+00:00"
},
"modified_dateutc": "2025-12-11T12:55:43.928537+00:00"
},
"marketing_segment_id": "d67c5ed5-5098-4262-bdd8-6608749bdc97",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c8670f16-c31a-4c60-a305-ae875a3b69be",
"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": "a3c27671-71ee-461a-a2e0-6234c1bf9292",
"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": "8da373c5-4011-465b-8306-43f9e629caae",
"db_country_code": "sample string 28",
"feelist_id": "de3b93c3-eb1f-4fca-b995-16e2e0321bef",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f6c7ec1c-3783-430c-a74f-8ee57ee91a20",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "14e84523-a8ad-46d5-afbb-d24c653ff4b9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-11T12:55:43.928537+00:00",
"db_currency_id": "f5b94e81-7107-4478-8761-39d8327283ef",
"db_currency_code": "sample string 10"
},
"company_type_id": "2b8e4b50-29f4-4418-a4c5-0dd9e0eb0527",
"company_type_name": "sample string 32",
"company_type": {
"id": "b01b3c34-4680-4e1d-9e7e-0d54b63f7e0f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a3fbf71-907f-4132-b05b-9a51e376cd24",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ec6d2e52-5410-47a7-9435-b4fc2698b23e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "95855769-8824-40c9-bc13-bec01897cadd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bdbd5407-5a85-4161-ab70-2b04e32072c2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4adf27c1-767f-44fd-8671-7fdcf23af06f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-11T12:55:43.928537+00:00"
},
"company_sector_id": "3d3cf0a9-e267-4de3-8c3b-5b1c3a3cfdee",
"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": "0aceaea3-ea0d-4069-846c-6ebc195b63b3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0ee17cad-eaf6-4848-97c9-27a73ffd54e5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4c65ef2f-29a4-4375-b29a-2f7546ec5cdb",
"account_manager_user_code": "sample string 56",
"company_status_id": "45c622b2-e9fb-4b76-ba90-2d25000d2071",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-11T12:55:43.928537+00:00",
"id2": 60
},
"db_language_id": "59b468a0-5d5e-4a18-bb06-0ba1ba140729",
"db_language_code": "sample string 7",
"db_title_id": "e8ead92a-2cc3-47a0-a34f-a0c233094471",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-11T12:55:43.928537+00:00",
"create_date": "2025-12-11T12:55:43.928537+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-11T12:55:43.928537+00:00"
}