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": "2d02de6d-189b-46d5-97ac-4b77a98bbc07",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "325a4d7a-1154-4036-8869-9d32d72c62a9",
"company_code": "sample string 5",
"company": {
"id": "dc68c378-03af-443b-8217-2465ff982701",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-16T20:00:37.5265552+00:00",
"sales_territory_id": "f07e6e06-6577-4b4c-9d95-b50980d246a5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "acb77cf2-6d5c-4896-96e4-962e074feb12",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bf39ec32-9c23-421b-b997-d5978bb83661",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8fde1bff-191d-4c55-adeb-d0d0c214d437",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6429aeaa-beca-4846-b13a-8824f6b9d204",
"db_currency_id": "681d1a9b-c96a-427f-98c5-7acb5f70e3d0",
"db_language_id": "fc5fc298-14ea-43e9-b4d3-dd302de4ee35",
"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-01-16T20:00:37.5265552+00:00"
},
"modified_dateutc": "2026-01-16T20:00:37.5265552+00:00"
},
"marketing_segment_id": "35e3c668-31ae-4c25-b5ee-94356ab4001d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "55072d8d-b97e-4a40-8b38-55ca75e59525",
"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": "ae5c2f2a-a65a-4278-8a52-212f67cf3006",
"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": "69b72bda-d831-4b6c-a339-9d64ae21e4f0",
"db_country_code": "sample string 28",
"feelist_id": "f3c140b8-dccc-42d4-a9a6-cde86226c554",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "be6badd4-028f-41e5-927d-02652821d520",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "befbcd79-56eb-4d7c-88d4-6ded422f37b4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-16T20:00:37.5265552+00:00",
"db_currency_id": "08d6c744-5168-4539-9082-6647069d49ec",
"db_currency_code": "sample string 10"
},
"company_type_id": "0520e164-c042-4236-85e0-85091054c05c",
"company_type_name": "sample string 32",
"company_type": {
"id": "bc1263f6-10c1-4a8d-8d14-8469005a6446",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "361362a0-aaf7-4425-83c8-5882197becd6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a2c60cca-f8c6-40df-a9cf-f54c9d6f8351",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "670b0702-6f7d-4463-99e1-c7fa94ed72da",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7bc79a0e-8502-4b59-adb3-d9a7e6474484",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1ad7ce21-741c-4b55-a82e-309f13da806e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-16T20:00:37.5265552+00:00"
},
"company_sector_id": "2fd788d5-ac86-4fe3-a8cd-b19d28389778",
"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": "59c47f26-ed8e-4030-99ff-db8fa5d0ddf2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a4984488-6ae1-4ee0-93e9-91d1c4560762",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "aa41c59f-a01b-4571-9876-924792ac0d02",
"account_manager_user_code": "sample string 56",
"company_status_id": "c0d1b75c-3570-4439-9a68-f7d74fadf270",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-16T20:00:37.5265552+00:00",
"id2": 60
},
"db_language_id": "b277456e-2737-4352-8a04-aee7bc85f4a1",
"db_language_code": "sample string 7",
"db_title_id": "7a29f001-97a8-4dcd-9729-ade45e745f5b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-16T20:00:37.5265552+00:00",
"create_date": "2026-01-16T20:00:37.5265552+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-01-16T20:00:37.5265552+00:00"
}