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": "2ba0b36b-fb28-47e4-bfd8-38bf74f2d478",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cf7470c2-1db8-4c82-8f53-0f09150bd506",
"company_code": "sample string 5",
"company": {
"id": "41ca24fe-ed76-4446-b054-934a9b09f5c4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-12T12:50:06.8512994+00:00",
"sales_territory_id": "a77edfce-3013-4e81-a819-d096f9bc12d6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "253f9a1c-370f-4ce7-82b7-225a2af6263a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "055ba7b4-078b-4c8a-9880-881b6a666015",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6bcc16d6-225f-4790-aef3-b1cf9e6b7fa9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a9ebdbd-b775-4d5d-82ea-056a5d035507",
"db_currency_id": "a5fd986f-165d-4a64-bd42-a2b9d180c2d9",
"db_language_id": "01f94564-b71a-4e00-9069-e66f3d0c90f2",
"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-08-12T12:50:06.8512994+00:00"
},
"modified_dateutc": "2025-08-12T12:50:06.8512994+00:00"
},
"marketing_segment_id": "440718f9-4db1-4647-a4fc-dd8df84dbb1a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "90fa0502-7f07-42b1-9d49-7df8d947f902",
"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": "5e359846-25a5-4145-85a7-654a7eba13fa",
"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": "94bd0c0a-6d29-4f20-a0e6-97aec26fe811",
"db_country_code": "sample string 28",
"feelist_id": "2348c7a3-d628-465e-8e30-f2fda4cf35c8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c2acd60d-3c03-4c3c-a55d-b8fb3c957ee7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "32c52c00-9054-4bb8-b05a-832309403113",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-12T12:50:06.8512994+00:00",
"db_currency_id": "4dccb5d8-c024-4e41-ad86-e92dacb52dff",
"db_currency_code": "sample string 10"
},
"company_type_id": "f6ddd625-6e2a-443e-a7ad-14ed5a893ba5",
"company_type_name": "sample string 32",
"company_type": {
"id": "907db629-5062-4e89-af47-6ea5c0176784",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "630c5905-772b-492c-b054-04d26960d232",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6da35a42-8c95-411a-b301-1118fc3bd474",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0aa5ac04-b7d2-4403-8aa4-27e129e43261",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ff510b23-ab74-4df9-8232-b35ecf060eb1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f191d6fb-a2ee-468c-b5ce-3d9fec48aecf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-12T12:50:06.8512994+00:00"
},
"company_sector_id": "f84253ce-24df-4a19-a6b5-03bb1b5a4f09",
"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": "5337270b-7a8d-40e4-a45f-8a9026fd1a1b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "57165cdd-70a2-4a1c-a689-26ea9f2b4ea3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "90ffd488-c6ae-44dc-8fd4-1d70f7a4a481",
"account_manager_user_code": "sample string 56",
"company_status_id": "90ab517f-4376-4204-a73f-38538914a6c5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-12T12:50:06.8512994+00:00",
"id2": 60
},
"db_language_id": "8a68c831-5a49-48ba-9da4-a1f85e291edf",
"db_language_code": "sample string 7",
"db_title_id": "b45df3d0-806a-4e1c-9662-713320d1fd66",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-12T12:50:06.8512994+00:00",
"create_date": "2025-08-12T12:50:06.8512994+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-08-12T12:50:06.8512994+00:00"
}