Retrieves all the contacts
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": "89f9a8d9-a872-4d84-bf06-f67daa90585a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "496a336a-c325-4a06-a6c4-82250c3ea305",
"company_code": "sample string 5",
"company": {
"id": "a08810e0-8a05-4989-be40-f80464536758",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-30T03:53:25.4151561+00:00",
"sales_territory_id": "4f1a0401-fee6-4101-af2d-3a29cfc9b50b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "87228d94-ee86-4004-a583-b1a197c4046c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "465c55db-67ac-4a2f-bf98-0a32993a2cc9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5cafe511-4a44-4b74-a232-53ded01f0bdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee8cf745-242f-4949-b8b6-9d584a6330bb",
"db_currency_id": "89124f3b-d7a3-43d7-92ed-f16c3787ffcd",
"db_language_id": "cbf536dc-3a6c-415b-8a99-4d0508e48a26",
"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-07-30T03:53:25.4151561+00:00"
},
"modified_dateutc": "2026-07-30T03:53:25.4151561+00:00"
},
"marketing_segment_id": "a1736750-83f0-4700-ab3e-be242028acc2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d6c77c11-53c7-405d-9d59-b53b7c961780",
"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": "cedf534b-4159-47e4-8aee-65d9c4d4edb6",
"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": "ca009737-a18d-4eba-9946-be2d53282608",
"db_country_code": "sample string 28",
"feelist_id": "978fded1-90ff-45bb-8106-90fbf283c954",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b4f92464-791a-4504-8526-08ea62b3b117",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e04e48da-b6db-4bc8-b2a3-fea0075c012c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-30T03:53:25.4151561+00:00",
"db_currency_id": "35a688ce-0c86-402b-9e01-726e27b33442",
"db_currency_code": "sample string 10"
},
"company_type_id": "2d276fb7-ab79-40d0-a2cc-2cfbd067bee5",
"company_type_name": "sample string 32",
"company_type": {
"id": "7824af8c-4d03-4cad-886a-96df4252b187",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2c322737-8517-4a3c-9f7a-3f9fcaaaed60",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e9d59a7e-2448-4320-a18e-be22a14fbf39",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5cd9d1b6-a231-40c1-bb27-914f7f55ae1d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "99f07ff9-464f-4ea8-aeb5-56510529d37b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c54a85dc-3115-459e-a3cf-6b7aa8d117a3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-30T03:53:25.4151561+00:00"
},
"company_sector_id": "b7bfb067-b934-4e7f-89c8-dd834c29ee3d",
"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": "89521ec8-b1d9-40e0-8471-14c573c66f9c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d214a64d-33f7-489c-953a-bef67417feb2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "288d0c85-c3fd-4e47-a842-4ffbf924b9aa",
"account_manager_user_code": "sample string 56",
"company_status_id": "381fd412-1bd5-48ae-b204-885beafd7677",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-30T03:53:25.4151561+00:00",
"id2": 60
},
"db_language_id": "c6562eb3-1be7-4296-a58b-6e2d857710dd",
"db_language_code": "sample string 7",
"db_title_id": "ff3e9c08-63f1-41e6-bd32-d0bc271bf89c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-30T03:53:25.4151561+00:00",
"create_date": "2026-07-30T03:53:25.4151561+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-07-30T03:53:25.4151561+00:00"
}