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": "26389de1-e206-4c4f-b289-f3fb8a9cbe4b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3e2f4fca-fd7c-4157-a1c3-9b2baf43ab35",
"company_code": "sample string 5",
"company": {
"id": "c1522353-76ce-45bb-9eab-6a7dc927f100",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-16T12:44:51.3415524+00:00",
"sales_territory_id": "7e64aced-02ab-4b2e-8024-a92cf2726ff2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6a27833e-891a-4bf5-b4f7-833f2c64a6f8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0f10b706-b933-416b-953f-46ed652ca83c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8a86176b-0059-44fc-97e1-0816fed1dc33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "efe7a2fd-015e-44c8-8275-86ebcf925d9f",
"db_currency_id": "9c868660-01f6-430c-af88-2ccb6284366a",
"db_language_id": "d5a2f1b8-5835-49ed-b4eb-3edfda4cb927",
"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-02-16T12:44:51.3571782+00:00"
},
"modified_dateutc": "2026-02-16T12:44:51.3571782+00:00"
},
"marketing_segment_id": "ca756b69-ba29-41c7-8073-60d07b465a39",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a70921bc-d31a-4168-8e00-53cad962f21a",
"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": "27a4c5b1-bbae-47c5-9fa5-f01fffa4a0be",
"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": "9ab3ac6b-90b7-4507-a22b-9bcda272df32",
"db_country_code": "sample string 28",
"feelist_id": "3764a53a-5abd-425d-a01e-48eb7b0bff37",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1f6822f5-a46d-4bc0-9caf-fc33e035e9af",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "42536f60-989c-4471-bf75-3ce56cfa0577",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-16T12:44:51.3571782+00:00",
"db_currency_id": "340cd812-68a3-4797-84a8-53b866fdd2f0",
"db_currency_code": "sample string 10"
},
"company_type_id": "068ab7cf-eeae-47a6-9a1b-28d73c7ea2df",
"company_type_name": "sample string 32",
"company_type": {
"id": "cf48c903-98cf-4e35-b068-3f37e6b0cde5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8d4ef734-182f-4fd2-95bd-4d95fa0afab0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "dcb32da8-d2a5-46a7-8e65-14ccc7929a89",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bfdb44a0-b8dc-4b85-b80a-5a53456493c3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "41cd5cfc-6b46-4cb8-be27-66c47e158761",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "825d7760-092b-4bed-b507-51450cc268af",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-16T12:44:51.3571782+00:00"
},
"company_sector_id": "49488fbd-5ecd-463a-9a32-ac9d7048945a",
"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": "374022b1-7f20-4ee3-8dda-321240324f71",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f76d9920-14ef-4274-bd34-2de1c8fb0ed5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c1b68fc5-c68a-4fcf-b2f1-59c5924f563f",
"account_manager_user_code": "sample string 56",
"company_status_id": "924e7845-3a3c-40c7-9fe5-466f571d22ef",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-16T12:44:51.3571782+00:00",
"id2": 60
},
"db_language_id": "d83a455f-432f-4421-84ac-012b590d83bf",
"db_language_code": "sample string 7",
"db_title_id": "47ac8a07-440c-480d-a70c-63e1b1d01d12",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-16T12:44:51.3571782+00:00",
"create_date": "2026-02-16T12:44:51.3571782+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-02-16T12:44:51.3571782+00:00"
}