Retrieves all the company contact
Request Information
URI Parameters :
None.
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": "736bd27d-badd-430b-81a6-64c517f69775",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "71fd1e87-0fae-42de-a17a-3b59ccd034f3",
"company_code": "sample string 5",
"company": {
"id": "a29a3550-a2c1-4b1d-843c-b6ddbeb2c2a1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-17T22:19:58.7158753+00:00",
"sales_territory_id": "0be103f6-f42c-4c8b-a5c1-42f2beea22e9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cd33c94f-0912-46bd-a8b1-4d464aa8341e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b0bb9a47-2b5f-4786-ae26-307308ea68f2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7af66799-c395-435a-ae3c-e75d2c2bf792",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8fec551c-9af8-4eaf-8793-7775be810ded",
"db_currency_id": "3a4ba0d6-e125-4a10-be12-b8363a928547",
"db_language_id": "c0cb16ec-7727-44a5-9649-515b94c4d962",
"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-17T22:19:58.7158753+00:00"
},
"modified_dateutc": "2025-11-17T22:19:58.7158753+00:00"
},
"marketing_segment_id": "8e217fdd-3bef-44ab-9b39-b5f580925461",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "acb9c372-4014-4813-b5a1-5f0064c764a4",
"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": "d54a726a-0038-4135-b385-bea513d020cb",
"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": "b8a9f079-2892-4c16-b39a-82e1953f0c4a",
"db_country_code": "sample string 28",
"feelist_id": "0f4ba5fa-7c88-4de6-adc0-2efa30788fec",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "eadfc6ee-b41b-4648-9702-f49228005a11",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dd1fc785-3cfb-4d7c-9041-39de93753419",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-17T22:19:58.7158753+00:00",
"db_currency_id": "9df7453c-589f-43af-9e84-693c3e0f52fc",
"db_currency_code": "sample string 10"
},
"company_type_id": "92c17397-8873-468b-a4da-2d8cec559777",
"company_type_name": "sample string 32",
"company_type": {
"id": "c3d3dddc-063d-42f5-ae73-799c05d5024c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "51153bb4-790c-45a0-a05e-604d9b374d95",
"sales_organization_code": "sample string 5"
},
"db_language_id": "be445531-700d-4428-9188-37bc14b67f75",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "82372e2d-8e2f-4be7-818b-7901cef0a4d2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "22f001dc-4301-4940-bcd1-ab90564d3684",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "243e411e-fa40-4145-aa94-a487e67b4f2a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-17T22:19:58.7158753+00:00"
},
"company_sector_id": "bddf4b11-60f1-47f6-930a-2fbe52f79736",
"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": "cbe49eb2-25e2-4a67-9a0a-b0fb35b7771c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "04271b0c-52f0-430e-abf9-f5eeae19d0e4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "83074e50-4464-42e5-b9e8-17157693f7ea",
"account_manager_user_code": "sample string 56",
"company_status_id": "dd62caf3-74df-4454-8344-d9485c2a86e8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-17T22:19:58.7158753+00:00",
"id2": 60
},
"db_language_id": "ada659d7-1145-4161-bf2c-ec532494aa54",
"db_language_code": "sample string 7",
"db_title_id": "23e31ddf-162c-407e-9af2-e4c593b595c0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-17T22:19:58.7158753+00:00",
"create_date": "2025-11-17T22:19:58.7158753+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-17T22:19:58.7158753+00:00"
}