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": "e38c9cf2-487a-4da4-8723-d09bc2c0159d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "193fa59b-71e3-4f7b-b5e1-fcf3f4234a8c",
"company_code": "sample string 5",
"company": {
"id": "4d059369-8712-4ff3-91d7-c6af4be25633",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-15T05:59:57.5930445+00:00",
"sales_territory_id": "19254e02-ea0f-4e75-83a1-92633412faf3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c9a73957-1be2-4089-afc8-5abb927eadc2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e6749709-809b-4350-a8f2-987a80184d94",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1e74a4fb-b63f-42d8-ac32-d8efc55e6b75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61ab1cb8-e8e9-4cc7-9c4e-a811d7fd7c43",
"db_currency_id": "27ee2ec4-96d9-4bfc-8c84-bfaa5e7a74bc",
"db_language_id": "54ca48ff-bc27-4f4f-b7d7-fd091e98abb5",
"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-08-15T05:59:57.5930445+00:00"
},
"modified_dateutc": "2026-08-15T05:59:57.5930445+00:00"
},
"marketing_segment_id": "020eef18-cae5-45de-99d9-2c83061ebaf7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f371cb19-f034-47c3-befa-7bee2fc5c7cf",
"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": "b1861ff5-a2e3-4211-a441-c2a0fe458da2",
"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": "e0aea955-f8cb-49f7-af5e-049cc2a8fdd3",
"db_country_code": "sample string 28",
"feelist_id": "624d0782-3687-4835-b092-a2f18ffc9b79",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "06dbef80-81fe-4837-8765-9825c55f1d5f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "71607868-96dc-4699-8108-729081faa996",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-15T05:59:57.5930445+00:00",
"db_currency_id": "998a200e-90b1-4f52-bb90-cf441b5069dd",
"db_currency_code": "sample string 10"
},
"company_type_id": "f2bb92a2-2527-425c-8c78-f0267b64d41f",
"company_type_name": "sample string 32",
"company_type": {
"id": "649272cb-c324-4f16-a033-b939579c8ad1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5b491cb1-2606-4d45-a1c7-f26ed11b1d85",
"sales_organization_code": "sample string 5"
},
"db_language_id": "40e0c1a8-01d6-4d2d-bd42-46c0bc4f022a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "02689bbd-c8e8-4be1-91f6-322b0cd1bb7b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5846aa1e-cfed-4806-9188-3edf61e5b968",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d7f1b75a-24be-4a08-a9b7-fd2834766c7c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-15T05:59:57.5930445+00:00"
},
"company_sector_id": "7c6a86f1-b66d-4313-8553-5376765f7d9e",
"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": "dd224bdc-9595-43bd-b798-5dcdeaffc647",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bc49c133-a3a7-4707-8cc4-eda47901eabe",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5c787d95-a773-48d5-b32e-af2d526c9ab9",
"account_manager_user_code": "sample string 56",
"company_status_id": "ac3418b3-b859-4c0b-a3af-d6f1a896b9b3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-15T05:59:57.5930445+00:00",
"id2": 60
},
"db_language_id": "291870ae-c253-4b57-9579-22ad3fa5bb8a",
"db_language_code": "sample string 7",
"db_title_id": "ad416c8d-0744-4f54-8a13-2f3794aba90a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-15T05:59:57.5930445+00:00",
"create_date": "2026-08-15T05:59:57.5930445+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-08-15T05:59:57.5930445+00:00"
}