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": "bd38bac7-0a46-48d6-b7e2-402fd94c8cff",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f143e3e3-9b69-4d1f-a1e2-4a29e8a78226",
"company_code": "sample string 5",
"company": {
"id": "9a54ba13-d044-4afe-9f81-4340c71d5326",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-08T21:29:12.2445275+00:00",
"sales_territory_id": "6524393f-3d3e-4082-92fe-91777380fae9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ed43b8f1-bd0f-4490-a998-57609db84ab0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b555cfde-f2be-49f3-afe5-ef7665995464",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "008491bd-3628-4d11-9c8f-1e1c7db1f623",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24c9a41e-8a07-4d5a-9003-b7b4390ef03a",
"db_currency_id": "ad73c857-121a-4a39-849a-c36860378a24",
"db_language_id": "d74b07e3-b3b9-4ab9-a39d-fb2f8fdc4d9e",
"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": "2025-11-08T21:29:12.2445275+00:00"
},
"modified_dateutc": "2025-11-08T21:29:12.2445275+00:00"
},
"marketing_segment_id": "8ff9f217-b36a-485e-a66b-ae1cf9b27649",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0692d808-974f-4b1b-ae33-6b17c9c3a06d",
"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": "3a21a1b7-30dc-4d6e-832c-8c37af25ab7a",
"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": "e21875d4-bbde-418b-9ec0-af6f0123ec04",
"db_country_code": "sample string 28",
"feelist_id": "0c82e5aa-54f8-48e4-ba2e-795a1bfaa97f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5edb1352-b1be-429e-b9b5-a7f14d28bbf2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9deb5edc-3afe-4c75-9ce4-9c00e5225d8f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-08T21:29:12.2445275+00:00",
"db_currency_id": "87992f9e-6476-4ab7-af56-1ecaafc512ce",
"db_currency_code": "sample string 10"
},
"company_type_id": "94278a7b-453e-4e60-af0c-b2af842b0887",
"company_type_name": "sample string 32",
"company_type": {
"id": "cf7a45d5-771c-43a5-9afa-918055969fed",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fb6f9f01-8c43-4ed2-81fb-04bd7be15a1b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ce7bff36-1acd-4e10-8bee-9a9877022d2d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b2b789b2-acdc-4701-86bf-82b0148288a5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cfa8e4bc-aa40-47a5-8826-4e6187192fcd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "40033d29-f4c7-4e96-b7e1-185aff0981f1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-08T21:29:12.2445275+00:00"
},
"company_sector_id": "acc9ba08-ec94-47b8-84c2-88df56efec00",
"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": "5e15d8dd-457e-4fba-ac2e-88866af46a4a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "57ebbccf-7f37-4e6b-876e-bd901be98d11",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e4f15e30-0848-4872-b1aa-52fa9f1c4967",
"account_manager_user_code": "sample string 56",
"company_status_id": "ff323891-ea75-4431-9415-347f12d851fd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-08T21:29:12.2445275+00:00",
"id2": 60
},
"db_language_id": "8feee901-94a4-412a-879b-11fcf3a38789",
"db_language_code": "sample string 7",
"db_title_id": "5f9e5619-87a9-4e8f-a6f5-2ecf58421c26",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-08T21:29:12.2445275+00:00",
"create_date": "2025-11-08T21:29:12.2445275+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": "2025-11-08T21:29:12.2445275+00:00"
}