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": "ebbca647-af81-4536-9852-41cbd87ab976",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bd71a073-7368-4a5c-8109-ea46f21ced3c",
"company_code": "sample string 5",
"company": {
"id": "0a7d5af6-3663-4457-960d-48a29179afa2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-13T00:02:31.5288256+00:00",
"sales_territory_id": "6a69c2cf-7bc9-4382-bd3e-22b9bd2a6050",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "80cbe522-bd8b-44d0-847c-5cd85479ea3e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bf3c5cfc-d315-4459-bce5-1730de60bf18",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9ede2cef-0613-4231-8336-5c0040c7385a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ba14d7c-d814-4305-949c-fb77b54e7076",
"db_currency_id": "cefc56f8-694f-4a9a-8362-830cffa42e6c",
"db_language_id": "30f31aec-86a7-4385-8185-b4d6b08d1cbb",
"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-10-13T00:02:31.5288256+00:00"
},
"modified_dateutc": "2026-10-13T00:02:31.5288256+00:00"
},
"marketing_segment_id": "3fb98e46-5e0d-4042-a368-c3ba4c4b1495",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c95e6c47-7673-4e9d-b4f3-80e2e4bcc63a",
"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": "a3c972b8-b04e-4666-bba2-a7dbff904ab9",
"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": "3180e118-521c-404e-83c3-e75a52038530",
"db_country_code": "sample string 28",
"feelist_id": "40a61e7b-8a14-4a27-b0b8-6dbf017b9945",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6932f672-4604-4dc8-bcd9-31bf7d50ee33",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "09608b05-6cf5-461d-93c7-177899f6bca6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-13T00:02:31.5288256+00:00",
"db_currency_id": "721c1980-8dd0-4741-911a-edb5ad42495d",
"db_currency_code": "sample string 10"
},
"company_type_id": "3d31e39a-024c-4f75-bc80-891c0fb0cb36",
"company_type_name": "sample string 32",
"company_type": {
"id": "5da1a395-0b6f-4497-8c28-519e982a441c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d60655cb-ea4b-4349-80ab-6149f6ea3b32",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ba25ecab-13af-49fc-9694-bc74693bbcea",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c9263a07-9657-4e03-8b07-c2476c4dbd19",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c243c85b-73ee-4f7c-93b1-976db9910786",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e9102fa6-ff68-4550-bf36-c2ee8a76e023",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-13T00:02:31.5288256+00:00"
},
"company_sector_id": "19ff8080-9b9f-483a-90b3-c61150f6cd5d",
"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": "ab384ac5-ee09-4d20-af23-39def5eaf3ab",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ff2eae24-2bf4-496d-8726-2beba43d3707",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c5b5f671-08e1-47a9-be84-a1f286066f00",
"account_manager_user_code": "sample string 56",
"company_status_id": "20cd602f-b0ed-4574-96a4-76fff5275450",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-13T00:02:31.5478907+00:00",
"id2": 60
},
"db_language_id": "1d996650-c8f9-4603-9122-56600bfff82c",
"db_language_code": "sample string 7",
"db_title_id": "743ee7fb-5cca-475f-9bde-7318c4f56a26",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-13T00:02:31.5478907+00:00",
"create_date": "2026-10-13T00:02:31.5478907+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-10-13T00:02:31.5478907+00:00"
}