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": "929e9e33-2bc6-4f90-b2a9-170c720bb8d5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "97c0512c-b890-4cea-a81e-bc8c0f82e716",
"company_code": "sample string 5",
"company": {
"id": "5c1018a6-0cfb-4ab8-ad5b-0110af7a9e47",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-27T08:16:15.9116314+00:00",
"sales_territory_id": "148fec84-38e1-4f8f-9a99-89e7cad44955",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7189e8ad-d325-4191-bb29-ea1b9f1b2984",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "513fbacf-c7c0-491c-b46e-0a4733b0abc2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b1198f42-00e6-4fb1-9a89-c2c88fcfc75b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "becd78d4-423a-4ef5-b466-3d7a9a720f56",
"db_currency_id": "ff1251d5-8def-4b41-86a8-49e3cf5b48c2",
"db_language_id": "d4644e48-008c-4c9b-ad90-a049ed20e030",
"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-27T08:16:15.9116314+00:00"
},
"modified_dateutc": "2026-01-27T08:16:15.9116314+00:00"
},
"marketing_segment_id": "f1452781-aefc-4186-8fd7-860b0c717672",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1d413c94-06ec-4dfc-a306-df005d4fa033",
"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": "d2273363-f606-4536-9e86-66856a2ce3ef",
"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": "6baae407-6c7d-4db9-a4e0-074d104b2940",
"db_country_code": "sample string 28",
"feelist_id": "50bc8e4d-8737-4fc5-98cf-eb8a02ada47e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ebc2c6d8-884a-43b8-ab81-c8f4f642f788",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0bba728a-940b-4127-9232-b4f95a1e2498",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-27T08:16:15.9116314+00:00",
"db_currency_id": "3d1d609a-6be2-422b-903d-be25063b21f9",
"db_currency_code": "sample string 10"
},
"company_type_id": "c7cfe3c6-e208-441a-972a-944c57d4cd2d",
"company_type_name": "sample string 32",
"company_type": {
"id": "589a8c81-c1ce-4d99-8ae3-128106d4d067",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c24a1c32-67b3-44c3-b7f3-2a6010653dbb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8e96c6c6-7ae3-4d0b-84f6-d1f1b52f2507",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5525aa23-4d40-40d3-80af-2c7933303030",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5c65af9f-c99e-41b5-9d18-9285791950a2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "07e7c886-dfe9-4b68-a81d-cf5250d54209",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-27T08:16:15.9116314+00:00"
},
"company_sector_id": "36845a1a-4119-493f-8d60-4c1c6b817e61",
"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": "308c9389-63d5-4f78-819f-d36615d5b83d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3dad022b-1e4c-4613-9b36-4eb7d1b649b1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c14f2b51-bc6f-44b3-91c9-8f9bcd2e9867",
"account_manager_user_code": "sample string 56",
"company_status_id": "11ecf5d6-e2bd-4d12-bac8-134528eeeaad",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-27T08:16:15.9116314+00:00",
"id2": 60
},
"db_language_id": "d644bb42-a441-4c71-bc38-f37d1156cfd3",
"db_language_code": "sample string 7",
"db_title_id": "0351fb08-d4be-4118-927b-3081d1060e26",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-27T08:16:15.9116314+00:00",
"create_date": "2026-01-27T08:16:15.9116314+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-27T08:16:15.9116314+00:00"
}