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": "746aa5b0-0a7c-43d9-81b0-6f5bfdb7fb62",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b1f01e33-15cb-481d-8e2d-8acaa3957370",
"company_code": "sample string 5",
"company": {
"id": "5cf3d0fd-b303-44ef-89e6-012d41d62bfa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-31T20:24:42.9597322+00:00",
"sales_territory_id": "d9301526-2244-44c2-9b2b-ad4bd2357f6f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f195b04b-95ac-45e6-94b4-5e3449896f29",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fa28fafd-7df0-4fa1-9106-c2d29c62f520",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "70b7878b-7b1e-4d7b-b56b-3582f951cc99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "020c69c0-e838-428f-843f-ac4c02fa3e79",
"db_currency_id": "93543e13-52ca-4d4e-9aa4-3866af37b559",
"db_language_id": "3146b29a-39ea-46bb-ba87-209092270ff9",
"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-08-31T20:24:42.9597322+00:00"
},
"modified_dateutc": "2026-08-31T20:24:42.9597322+00:00"
},
"marketing_segment_id": "80954914-5a50-4780-b24d-4d3b7a7674e3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "316225a6-8ee3-4a34-99f5-44c8793f77f9",
"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": "fff8b32b-965c-4487-adbf-030835928ba0",
"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": "a039ec8f-6856-4213-8d60-f09f611a8681",
"db_country_code": "sample string 28",
"feelist_id": "3be43073-81fa-407b-8117-ac35e2f44657",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1051f7e0-7910-4b95-8727-fee25cdf1bd4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "93b2011d-43dc-4ed4-b49f-16fb6607ad8a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-31T20:24:42.9597322+00:00",
"db_currency_id": "2c22a47b-0b19-4c14-803e-e99a0f3f6007",
"db_currency_code": "sample string 10"
},
"company_type_id": "ba0d97d7-cdbc-488e-a18b-abb3c90ad251",
"company_type_name": "sample string 32",
"company_type": {
"id": "d9665d42-859f-44dc-a31a-7c59f6ef2d76",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e7fd5679-0a0e-4b85-a3dc-701e70a83653",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9ff3c021-942f-4002-aebe-8d065687fbef",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "aaffaefe-b024-4947-bdf5-621818ca46dd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6c70e171-dfce-4fe5-8519-d7b8d8670460",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4f77775b-d2c9-4d47-a2c6-5b9f59913646",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-31T20:24:42.9597322+00:00"
},
"company_sector_id": "e9993a19-a476-4c6a-b245-82ba4e3beabc",
"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": "9e00cc78-0192-44d9-b2ce-ffca0245d791",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "05d1d60b-0afb-4d23-a3a5-cced2d2b462f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6932c268-4a64-498d-a94c-5998c0e50bed",
"account_manager_user_code": "sample string 56",
"company_status_id": "5d7594e7-dfbf-4a3e-900d-600e18b1dcaf",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-31T20:24:42.9597322+00:00",
"id2": 60
},
"db_language_id": "e3edb220-4f0f-4f1f-bca3-efeb8e382465",
"db_language_code": "sample string 7",
"db_title_id": "6bab9b29-9cb6-4a81-8d60-70feb6899ae8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-31T20:24:42.9597322+00:00",
"create_date": "2026-08-31T20:24:42.9597322+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-08-31T20:24:42.9597322+00:00"
}