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": "6c82d9c5-6095-4834-a839-86c30b2c03bb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4511fbf0-e7a1-48cc-92ff-e1f0cc947061",
"company_code": "sample string 5",
"company": {
"id": "1c16328d-dc55-40bf-943e-b533a5d62288",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-06T23:13:05.2519842+00:00",
"sales_territory_id": "90dfa70e-2a49-4de3-b7e6-767e4dc1f21d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6d8990bc-562f-4c60-8b19-1d024c439bbb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1361acfe-fc4a-469c-b4f6-77d4048d2557",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a5fa2f4e-7ec4-4f37-946c-0a105eee96eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "acbc0911-1c23-49f5-a105-7683ad006c3b",
"db_currency_id": "02168fed-8769-4467-9e81-673f21b85dd9",
"db_language_id": "cf8b5d9d-4cfa-4ab4-9fc0-49d9f8669f52",
"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-06-06T23:13:05.2519842+00:00"
},
"modified_dateutc": "2026-06-06T23:13:05.2519842+00:00"
},
"marketing_segment_id": "e7af9c20-9506-4b76-9f1a-9de8797db9a0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "acb568db-fff9-4e68-8ea9-500732be4d3e",
"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": "a7e711cd-4ae0-412e-8fb2-f351427e2676",
"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": "d113f47d-fc1a-4a92-be07-aa38e05c23da",
"db_country_code": "sample string 28",
"feelist_id": "340a8128-9406-41c0-b115-e8a4c7f58be1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "73ca395e-c90e-4af3-bc41-a1281990ef6b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6366004e-282a-4ea3-966d-b833b5c1d0f8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-06T23:13:05.2519842+00:00",
"db_currency_id": "a09dc479-a292-4ffb-ad9a-83fa804e6828",
"db_currency_code": "sample string 10"
},
"company_type_id": "0da7cba5-d9ce-44d3-a151-6af27c8894e9",
"company_type_name": "sample string 32",
"company_type": {
"id": "5bf0d159-9920-493c-9f26-360f0cccc3df",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "07dc2659-2082-402f-9391-a9e98b693d26",
"sales_organization_code": "sample string 5"
},
"db_language_id": "33ad463a-55c7-44b4-9683-77dfa023300a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7a443830-81cb-4f83-812f-7ac0753e6566",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "eab2c87e-e490-4448-94b3-3628326b97f4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e92b092d-d733-408f-9fe4-fa1d116ff3a9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-06T23:13:05.2519842+00:00"
},
"company_sector_id": "ca6fca21-780b-444b-bfc2-dc1ad2f8ed5a",
"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": "254050c9-f831-40f3-891e-e1d24ab4b072",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8682079d-ee85-4b9f-8cbd-65bdf7256d40",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7deba006-c7d3-4502-bb51-fa93eeef981a",
"account_manager_user_code": "sample string 56",
"company_status_id": "40f5e56e-ccea-48db-954c-5b8f1008dce4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-06T23:13:05.2519842+00:00",
"id2": 60
},
"db_language_id": "8e540700-9a3f-490a-a17a-f89ef57f8bb2",
"db_language_code": "sample string 7",
"db_title_id": "897dc250-5211-4fcc-9571-6950f784d0dd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-06T23:13:05.2519842+00:00",
"create_date": "2026-06-06T23:13:05.2519842+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-06-06T23:13:05.2519842+00:00"
}