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": "de4bb69c-4ba2-4834-9c15-e4c2b6433b9f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "13e01419-3514-42d4-b4bb-b2026234e70f",
"company_code": "sample string 5",
"company": {
"id": "b6acf9c4-cfe5-443c-8504-1810d4e64ecf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-22T22:06:32.8883107+00:00",
"sales_territory_id": "7078fd90-261c-4899-a8eb-c15d5c9632f3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "035b0b31-541a-45f4-9e5b-04736b8866a1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cbb692e4-89cd-4de6-8738-fc3eeaac58ba",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e9fcc517-0489-4fd1-b122-54a1bd73b929",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fede2e1c-ff30-4342-9fb2-372d539c147c",
"db_currency_id": "f67037d3-ee36-4fde-8ef9-ad44dafa7789",
"db_language_id": "2753587b-75c4-4a29-a290-a00058546001",
"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-12-22T22:06:32.8883107+00:00"
},
"modified_dateutc": "2025-12-22T22:06:32.8883107+00:00"
},
"marketing_segment_id": "9a0bdcae-e4fd-4827-8506-6980f2d384bd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "45025158-80a6-43d6-8662-ee6d3bb22957",
"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": "e78df0c6-d51f-43f5-a6c5-478384a0ad9d",
"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": "cf8e389b-3c22-45ff-9908-79f037d257c0",
"db_country_code": "sample string 28",
"feelist_id": "1bfe1030-805d-4447-b20b-6d8d317c8853",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a80e28f3-2100-41bc-934a-cee4ed14ce45",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2c951f2c-38b4-436b-995c-5bc12c4b453b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-22T22:06:32.8883107+00:00",
"db_currency_id": "119d0166-fee2-47f8-a92e-e9fc9e43982b",
"db_currency_code": "sample string 10"
},
"company_type_id": "1e695f69-043b-4234-b04a-6e181c3de072",
"company_type_name": "sample string 32",
"company_type": {
"id": "6435ed63-bd5d-43ca-b8a2-65a7353540fc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0d9ade17-1c87-4ce3-8819-9c6606c6513d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6232c55f-a0f5-4343-a990-8c0393620282",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c8419a8e-6c49-4caf-90ea-b133e7cef699",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6f7042ef-6756-4c58-b871-75e422b01f89",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "922ddbcb-79f1-4435-b490-13bd0910edac",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-22T22:06:32.8883107+00:00"
},
"company_sector_id": "8947f8b2-5890-4dbc-b215-d45ea44e9381",
"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": "ca0420ea-41bf-4794-9125-0b83384b4cb9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "48500166-96ba-4fe4-a5dc-ce6e9bc1757f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f6b0263c-7feb-4ab2-be9f-77d89ef2eb8c",
"account_manager_user_code": "sample string 56",
"company_status_id": "36b4067a-d560-4b96-a48f-0f1d4460dce1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-22T22:06:32.8883107+00:00",
"id2": 60
},
"db_language_id": "c4abcaa6-044f-431d-a8e9-9d66bd53113a",
"db_language_code": "sample string 7",
"db_title_id": "5251a298-7a3f-493c-80c0-bca341b0bdf7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-22T22:06:32.8883107+00:00",
"create_date": "2025-12-22T22:06:32.8883107+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-12-22T22:06:32.8883107+00:00"
}