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": "a0a63ccd-10de-4c1e-8822-2ac098b810d4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8e16682d-2362-4978-ad07-6cc50ea13fb5",
"company_code": "sample string 5",
"company": {
"id": "4c6a3def-9692-409c-b839-1ab73f7d4eb9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-14T14:01:41.5889468+00:00",
"sales_territory_id": "1b1b1edd-a58b-4964-af46-25f56c7bb843",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ee0b31e1-31f1-4988-96c4-5559b8a2c26c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "307c4ee5-9cbe-4001-b3da-b8c58e7b97b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "df2c03d7-ad76-4367-b6eb-de0ddeb4da52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ec417cf-342f-449e-b269-a8c6bf526134",
"db_currency_id": "6b0df618-21bc-42a3-a949-9ac338610571",
"db_language_id": "534ee351-13f5-4f6e-9091-06875e23f284",
"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-09-14T14:01:41.5889468+00:00"
},
"modified_dateutc": "2026-09-14T14:01:41.5889468+00:00"
},
"marketing_segment_id": "7a813dd8-c15a-42c1-b218-2b0ad09980f2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "04f33070-205d-44f5-a0ab-ba7089b2434e",
"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": "277596b5-e218-48b6-b5f0-3605dbe5c46b",
"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": "d21a650a-5209-46a0-81ff-ff1603f4c0ac",
"db_country_code": "sample string 28",
"feelist_id": "c750e4c0-62d2-41d1-b8b2-d9e2ebb56d95",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1a786dd6-72c7-495b-91d1-d7eebdbc59cd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "059117c5-4cf5-41cc-83d0-d395809faf9c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-14T14:01:41.5889468+00:00",
"db_currency_id": "705d3802-3345-44a4-afed-1c9d7f798e31",
"db_currency_code": "sample string 10"
},
"company_type_id": "0042caad-8197-4e58-9dd9-4851804371c2",
"company_type_name": "sample string 32",
"company_type": {
"id": "79cdb44b-0870-48f5-adf6-90d49e1202ce",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "de7e9238-b343-4bfb-8764-7e0ba35d4a28",
"sales_organization_code": "sample string 5"
},
"db_language_id": "21395f96-b8dc-4056-a382-2a224a50f41d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8818546a-482a-47a5-ad68-3d0487b3b4c3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "95a17392-f1c6-4fca-b6a9-67c027a331ad",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4c5a9330-7feb-4472-bc39-23b9e253d48f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-14T14:01:41.5889468+00:00"
},
"company_sector_id": "8010449e-24a3-4464-b6a5-9d00454fa1b5",
"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": "5e872fd7-2ef3-4ab5-a157-3a8d08ebb802",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0110180e-1f45-42c1-99e5-b273c91ce94e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9112f8b5-da35-4b74-9c21-681762652bad",
"account_manager_user_code": "sample string 56",
"company_status_id": "16c1bacd-6e5f-45ad-8adb-d62e710df422",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-14T14:01:41.5889468+00:00",
"id2": 60
},
"db_language_id": "9d8ef770-7064-4b25-8257-29a993cbdfc7",
"db_language_code": "sample string 7",
"db_title_id": "5bc08441-22aa-4544-81c9-4da52586e8d6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-14T14:01:41.5889468+00:00",
"create_date": "2026-09-14T14:01:41.5889468+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-09-14T14:01:41.5889468+00:00"
}