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": "02d855dd-9372-4654-b53a-525c849366b4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6fa828b0-0f59-4ed5-934f-01638887d7ca",
"company_code": "sample string 5",
"company": {
"id": "e83a5e1e-30fa-4824-964e-ed985773c3dd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-22T22:11:14.4989289+00:00",
"sales_territory_id": "91a8bd5d-052e-4428-8cc1-be6ddf06c636",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0acf6670-a1e6-412d-89f6-a2bff404be14",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "00317f19-75b8-4a15-8368-b321dfc18b72",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1daf0405-00b0-4c5f-9c58-4ffe5322ac0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7bc5efe6-910c-4b35-ae1e-2037152e7a57",
"db_currency_id": "ab042def-0441-4275-9678-7463f97671d1",
"db_language_id": "f4885481-5abd-466f-81e9-1455eeca4666",
"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-10-22T22:11:14.4989289+00:00"
},
"modified_dateutc": "2025-10-22T22:11:14.4989289+00:00"
},
"marketing_segment_id": "ee2d9f53-04de-4032-af48-6dac86212a9e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c7d68451-f9c7-45dd-ab32-ce2580dfda9f",
"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": "455ae6a3-29c0-4e59-a987-cfec002810d2",
"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": "e4b46d25-5ad1-4351-ad7f-61a3c6b37d75",
"db_country_code": "sample string 28",
"feelist_id": "5bd39b39-71ac-43f9-beec-415fc8a3b97a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2fc98e9d-d5e3-4eed-a5ca-9262976d28da",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "59db8124-01ac-4b81-9e05-c8271d43187c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-22T22:11:14.4989289+00:00",
"db_currency_id": "5bae97d5-85b9-4c4f-b1e4-62fd19402aec",
"db_currency_code": "sample string 10"
},
"company_type_id": "32a18ab8-cbaa-4d18-b6a4-73ade7e01075",
"company_type_name": "sample string 32",
"company_type": {
"id": "86049212-0bc6-440f-bb80-e862ca951f1d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "86d428a4-0cc5-4e78-b294-d2afec6bb0b3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c3892615-2b9f-42c7-ab55-d67905d21a3e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a376a61d-f02c-437b-ac8f-220ca09933e1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "15302a77-7b69-48ef-bf82-9b2dcfff1fd7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a4eb2bce-5292-4550-80bd-79047804b21f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-22T22:11:14.4989289+00:00"
},
"company_sector_id": "d5090954-a1ed-4324-89c5-0221bd2338c7",
"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": "7d638186-0a0b-4efc-9e72-5e5bb957fdc9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c4bf3e69-1d9b-4158-a5c9-49ea12314099",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b1724ec4-75a5-4934-91e5-3d6cdf5494e1",
"account_manager_user_code": "sample string 56",
"company_status_id": "d7d38c3a-9c75-43eb-a9eb-be1eb9d721fd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-22T22:11:14.4989289+00:00",
"id2": 60
},
"db_language_id": "b1e7b3b8-81c3-4d58-aefe-16f785d42a93",
"db_language_code": "sample string 7",
"db_title_id": "77f3e2f9-a6e9-4f6b-b2ab-3f42bd51ef31",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-22T22:11:14.4989289+00:00",
"create_date": "2025-10-22T22:11:14.4989289+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-10-22T22:11:14.4989289+00:00"
}