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": "ad658483-53ea-4cd1-bd9e-a2afd867d3b4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dfe354f3-62b9-485f-8fa2-f6784fc8e392",
"company_code": "sample string 5",
"company": {
"id": "ddc48eb5-c3d3-4ca1-a693-e2ad95f21bcb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-05T01:48:51.2454268+00:00",
"sales_territory_id": "ca70da44-94c7-4100-b95d-9ffd28862f1d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "15a2331a-892a-4e6f-a2c0-e42a2d893ec5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "393e3ca1-5aaa-4fbb-bd4b-fc6642b60940",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3a6fc436-328a-4016-9666-3db9deff2072",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3042180-b508-433e-be5b-d48dc5bdb326",
"db_currency_id": "2a494ea7-b927-4ce2-a04f-64f26f8d9d94",
"db_language_id": "2da35871-c311-40e4-a310-ccef9b8ce849",
"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-05T01:48:51.2454268+00:00"
},
"modified_dateutc": "2026-01-05T01:48:51.2454268+00:00"
},
"marketing_segment_id": "c9635149-493b-4a8c-818c-d1a744ffe518",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9142c0f4-3c42-4605-bc0a-037cd1e8a54d",
"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": "7b72191c-2846-409a-94cd-8310ef1f2f4e",
"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": "0dccf0a8-230e-42ce-816f-da6be4ba85e1",
"db_country_code": "sample string 28",
"feelist_id": "a59163d9-c79f-4565-8060-ded2df33570d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "38059ee8-0ba0-4991-9ee6-e3bee731c9aa",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "590e3cac-8c39-46dc-a2e3-dd6161abf62a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-05T01:48:51.2454268+00:00",
"db_currency_id": "7fd686c1-8a20-4930-8c03-a6bdc5245131",
"db_currency_code": "sample string 10"
},
"company_type_id": "721faaa5-1361-48b9-a257-79f68699913c",
"company_type_name": "sample string 32",
"company_type": {
"id": "d3361fe5-658f-4171-9f20-f0ae4c3b588e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ae80eb1a-0ab7-4581-97c8-20f0cf809ce5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "59875a9c-5078-4af7-a65e-4bc728984ea1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "81f2107f-a2d0-493c-8fd0-34d59ac112e0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "37536b3b-b336-40f8-b6be-1a4c631eb90a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f82c26c8-6c1f-48e8-978c-c08f39b2ad80",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-05T01:48:51.2454268+00:00"
},
"company_sector_id": "14c02693-9b41-4616-9a33-177c73d013ed",
"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": "d0c79efc-a835-49c5-8e03-1d2d597de7d7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0448e311-812a-406e-bdeb-ee749fcb36b6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "31a334a2-e9eb-4f19-afd8-cd640d60de13",
"account_manager_user_code": "sample string 56",
"company_status_id": "09869266-4db2-4f03-8974-919c38cc64a5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-05T01:48:51.2454268+00:00",
"id2": 60
},
"db_language_id": "d14ebea7-fafc-4752-95ae-7942146ad1d4",
"db_language_code": "sample string 7",
"db_title_id": "138da46b-1c58-4268-8515-3710b36715d0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-05T01:48:51.2454268+00:00",
"create_date": "2026-01-05T01:48:51.2454268+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-05T01:48:51.2454268+00:00"
}