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": "7e4fff41-6a6a-4681-9d5f-608bdfc05d35",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5415f2eb-ba8b-47ee-8231-30cb79ec2e63",
"company_code": "sample string 5",
"company": {
"id": "c312a3b0-b304-42b6-a720-284f5e32a958",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-17T13:54:56.9003395+00:00",
"sales_territory_id": "df8bffd4-0b9a-470f-a773-6a9f51776795",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "486298dc-4e10-46fb-8258-3442af5a22db",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e6104d39-d0d5-4862-a73c-db055d76e5a6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "78a696be-5ded-40ef-aa55-21c35f477b73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "665b42e7-ca33-441b-9029-cd5160b7e8a8",
"db_currency_id": "d18b2163-84f0-4837-9901-8009c74364ad",
"db_language_id": "b859d9a1-cecc-46ec-80f2-53d22216ac14",
"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-01-17T13:54:56.9159675+00:00"
},
"modified_dateutc": "2026-01-17T13:54:56.9159675+00:00"
},
"marketing_segment_id": "7dee4d18-07d6-45cf-8d1f-1e33e62e7a50",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ccc45d92-1433-4aa4-8006-ed15c591be20",
"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": "d89042fe-6d40-48d7-a934-1d425e8f6a0a",
"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": "081cc3df-5d37-4fc5-b115-6d17c579a7e7",
"db_country_code": "sample string 28",
"feelist_id": "71733fd2-780a-4150-9467-d21ff9c06d2c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b7c8a446-18f6-4a4a-bfa5-1247b0ac6ccf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "20735cc6-094c-41de-88b3-2da23d2ea43f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-17T13:54:56.9159675+00:00",
"db_currency_id": "963b6935-a6bb-4b4b-8843-3712d1048169",
"db_currency_code": "sample string 10"
},
"company_type_id": "e500715b-5a62-407b-9ae6-3456ef9c52cb",
"company_type_name": "sample string 32",
"company_type": {
"id": "0339614c-e97d-4f2a-ac42-a01a5ce87dbe",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6356268e-b301-42b6-92c9-42a482e9575b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5c7997f1-efc5-40e8-b473-3591a6b61ee4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5b30dc9d-fa8b-4f30-92a4-bcd491d00f38",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4489b634-1be9-45e2-ab7b-44f109b28c6b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2f188e5a-730d-4121-bd88-f0aea9c2985d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-17T13:54:56.9159675+00:00"
},
"company_sector_id": "e0d3f8ab-ba9f-40a4-932c-4a5ba1d2f41c",
"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": "126e5ed5-4ed5-4666-ab70-fd222f06ef00",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eda147a2-057f-4bef-b5bd-6da05ed9505d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c516b113-6911-4c34-949c-8e986f6ad963",
"account_manager_user_code": "sample string 56",
"company_status_id": "67d507cb-3638-47af-9453-75166e5ea6df",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-17T13:54:56.9159675+00:00",
"id2": 60
},
"db_language_id": "b6f173f0-2ecb-4127-ab03-0ecfdcb8757c",
"db_language_code": "sample string 7",
"db_title_id": "6f09c949-c665-400c-9705-ed6befe1f306",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-17T13:54:56.9159675+00:00",
"create_date": "2026-01-17T13:54:56.9159675+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-01-17T13:54:56.9159675+00:00"
}