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": "964a6ed5-1498-4a74-9659-eb48f44e570a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "03303509-4570-4e6e-900c-12ebb40466f6",
"company_code": "sample string 5",
"company": {
"id": "c13751fd-e711-45ad-b74b-53fbeb3ca230",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-15T17:41:47.8977531+00:00",
"sales_territory_id": "9a49e75d-17f3-4358-a9cb-8a970f7fbc65",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "03a93575-32ec-464a-890d-8010c8dea94e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "25c24e9f-8212-492f-8a14-ce58641309b2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1649e751-c5a9-40c6-9d82-40244cd247ec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1be28e6d-b1a1-408f-8a19-512d23cbe5d1",
"db_currency_id": "ef307b14-3243-4270-a2d0-72d7141d44a1",
"db_language_id": "36a8f309-ad9f-4bdc-bf15-ccc50c971118",
"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-02-15T17:41:47.8977531+00:00"
},
"modified_dateutc": "2026-02-15T17:41:47.8977531+00:00"
},
"marketing_segment_id": "8c3fc93f-f132-48e4-8fc7-2ae6837a787b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d3ec895a-f316-447d-8743-9be47d24c19d",
"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": "594ffb5f-5ee4-4d86-a832-ec5cccafe3c3",
"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": "eacdf61f-7f12-4b38-a11f-62a270c78bf8",
"db_country_code": "sample string 28",
"feelist_id": "9ab9f817-1869-4d3b-aee4-9fab7f09e25c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d0582202-585c-44e9-a03f-6282198638bd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e0bb4146-0115-4e93-a5c9-7d7275059a09",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-15T17:41:47.9285894+00:00",
"db_currency_id": "e98f53ef-9205-49e6-817d-ba4dfb2f4475",
"db_currency_code": "sample string 10"
},
"company_type_id": "ec722ffd-1b1c-4370-a674-2a8bb4bef48e",
"company_type_name": "sample string 32",
"company_type": {
"id": "ff7f9d4c-ecbd-4780-8f70-de79209a4398",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f230e621-cfce-4cd6-b7b7-998789f15276",
"sales_organization_code": "sample string 5"
},
"db_language_id": "007c39bb-c9d1-45d6-babb-27767027e27b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "328d55e9-6c5b-4145-8c76-6da3531d34ca",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b7867f43-3b1b-46d2-885b-9af334afbce9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d19c241c-6caf-4102-b789-63dbf28a9e2b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-15T17:41:47.9285894+00:00"
},
"company_sector_id": "36820d52-d409-4403-95f3-ecf4d248e548",
"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": "436b5543-3518-4c98-a2bf-094248b00ee8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d319347a-9c6e-4657-9fc2-f3c037bbf958",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "eddf076c-e2d9-4358-8e79-ca6e3185b373",
"account_manager_user_code": "sample string 56",
"company_status_id": "db22c374-754a-4f44-9239-2a313b0a7b51",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-15T17:41:47.9442237+00:00",
"id2": 60
},
"db_language_id": "8bfb57fb-29e8-4197-9066-98095f69bba2",
"db_language_code": "sample string 7",
"db_title_id": "791d2253-18ed-47ef-b12a-206c7fb577ad",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-15T17:41:47.9442237+00:00",
"create_date": "2026-02-15T17:41:47.9442237+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-02-15T17:41:47.9442237+00:00"
}