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": "d49a1bd7-8947-4190-bf3d-8988d6e0dd6e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6074f4f3-bd4d-439f-b413-17bac22e96ed",
"company_code": "sample string 5",
"company": {
"id": "49773ba0-951b-4a53-9245-c530349ba3e4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-06T08:36:15.6140032+00:00",
"sales_territory_id": "7e6bc279-0798-4798-9a64-1ca644fd09a9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "90517ce2-b87c-4bb3-8824-f36960e76756",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "db1a572d-e7bd-4a02-9dd5-85552b43a4c0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1d330f4a-8f82-4a69-a862-ba06d45f306c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ea5b81e-131b-44a4-ad8f-d7d2edc95f38",
"db_currency_id": "db7c1534-760e-4999-8f2f-b81083f59da6",
"db_language_id": "77997bb2-3d51-46c1-ace9-e005eebc0633",
"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-03-06T08:36:15.6296278+00:00"
},
"modified_dateutc": "2026-03-06T08:36:15.6296278+00:00"
},
"marketing_segment_id": "db12e56c-eae7-4bab-96e9-7abc4a5bf87d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7d9ae30f-8b9d-4772-ad9c-701d61aeadc5",
"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": "fb7541fd-6fc4-4755-8d42-1eca44b2bb99",
"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": "a7a68874-e5a6-4bde-ac8c-81460fd5e9dd",
"db_country_code": "sample string 28",
"feelist_id": "447fcbb3-8279-47c7-a0a4-6ae7f3a8ca11",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9913c06a-e6e3-4f0b-9b92-b1671e1f89eb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "677a802b-d17d-48e8-9d3d-e6edf3da2f12",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-06T08:36:15.6296278+00:00",
"db_currency_id": "dc1a58d5-62d1-40b7-af02-7b4488b2d55a",
"db_currency_code": "sample string 10"
},
"company_type_id": "f8b90d19-616f-4e45-81f8-7c8dc58cac5b",
"company_type_name": "sample string 32",
"company_type": {
"id": "f786e894-99a2-4080-8ce2-6eb68db64481",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d08a9c55-8c62-4012-85e1-a2ade7276be1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bc0fc158-d686-4818-98b7-86ad999ed22e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e208d971-b4a5-4c8a-a5f2-3db2c98e0b1b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f2dbc9fe-b066-4b86-a753-31485798912c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b8951c31-7aa6-4a3c-8291-4b3b0a9464ed",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-06T08:36:15.6296278+00:00"
},
"company_sector_id": "e1950a5f-f0c9-485b-99bd-1909c6381077",
"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": "15aa45e9-074a-4312-85ef-8c1e90d573f1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "87357ef2-a9b8-4285-8ce4-2a8b680394ab",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fb317883-b75d-4a3c-9d0b-6b7bd8b82795",
"account_manager_user_code": "sample string 56",
"company_status_id": "3c5788b6-6c57-4a7c-997a-826c26088948",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-06T08:36:15.6296278+00:00",
"id2": 60
},
"db_language_id": "cd3bd50a-feee-45fc-a2e3-80cdbf5f285b",
"db_language_code": "sample string 7",
"db_title_id": "b60fa70c-3925-4b21-b0b0-d22b3c453905",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-06T08:36:15.6296278+00:00",
"create_date": "2026-03-06T08:36:15.6296278+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-03-06T08:36:15.6296278+00:00"
}