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": "da8a17f3-d075-4e5c-94eb-2da0383bbf8e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e32c8c3c-4e83-4917-9dcb-e427fabadf7b",
"company_code": "sample string 5",
"company": {
"id": "4c1b8c14-cc3f-4997-ac35-5f4911b3971a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-04T23:27:11.9722999+00:00",
"sales_territory_id": "6b00e221-1dc4-4841-97e5-2a22f38c516b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d589247d-7497-45ca-bad6-909cc263fda2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e9575d5d-e33e-4dcc-8399-5d8084cff418",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "46413c05-07bb-4b21-b1b6-41405ad768bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85317547-c5f8-4c8b-a2a4-75f16a4c834c",
"db_currency_id": "cea866aa-5205-4be8-b048-d8367111032d",
"db_language_id": "c042f494-4da6-479f-883a-be92460dd789",
"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-07-04T23:27:11.9722999+00:00"
},
"modified_dateutc": "2026-07-04T23:27:11.9722999+00:00"
},
"marketing_segment_id": "4589f46d-1c3f-4e48-8ba4-ab0ea5961d01",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "84b03a0f-d716-4475-8041-f62ef3921d31",
"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": "1e1ec4f4-384d-43b7-a214-0c818a8cd489",
"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": "cba2e999-00cc-4b97-8140-15afb1142036",
"db_country_code": "sample string 28",
"feelist_id": "3ad1abec-8edb-41ad-9531-b377d9d07b9b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d39f2399-34bf-4637-a922-de1ed9fdfce7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1b4e0a2c-0e3e-4d17-a475-9193c5d1f17a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-04T23:27:11.9722999+00:00",
"db_currency_id": "efbb46f1-74af-4fe3-827f-e46bf65ed612",
"db_currency_code": "sample string 10"
},
"company_type_id": "2728d17f-bfbe-4f9a-a914-c847b7a4a45a",
"company_type_name": "sample string 32",
"company_type": {
"id": "4dd2c502-68da-464e-8498-38216a162c61",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8fea7b60-2538-4638-9096-dab8c50150bd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "836c3220-a1ce-4b80-8384-0c652bda6139",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "120866e9-bfd1-4544-95c3-b63c9b2dfd2c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a3d71034-4d45-4366-9d0b-5ed7a2da9a39",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "65a20c5f-9081-4274-b0ef-9d72ed06846b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-04T23:27:11.9722999+00:00"
},
"company_sector_id": "240f51fb-1a34-49da-b92d-b0e15888e7b2",
"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": "52224eb3-7a4c-47e0-93da-19ffe355dd66",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8185bca7-b2e4-46fe-8fdd-5564ad5acab7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "86f72748-0397-4efb-8a17-27065a38246b",
"account_manager_user_code": "sample string 56",
"company_status_id": "01de94bc-ded8-436c-93a7-ed86e95f34ca",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-04T23:27:11.9722999+00:00",
"id2": 60
},
"db_language_id": "a057d03d-4690-4a96-88c8-6e3e2c0e83de",
"db_language_code": "sample string 7",
"db_title_id": "b0ca72d9-5605-48f6-9ca4-335178fbf9d6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-04T23:27:11.9722999+00:00",
"create_date": "2026-07-04T23:27:11.9722999+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-07-04T23:27:11.9722999+00:00"
}