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": "86f8fae3-df39-44c9-a70d-0fb547b953d3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2ec89308-4067-47f0-92e7-a08041034427",
"company_code": "sample string 5",
"company": {
"id": "82cec350-6a45-4721-b48e-25f20a0584af",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-28T02:43:30.5026604+00:00",
"sales_territory_id": "7fc91110-91ec-4b0f-a878-be2d668def67",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b572d71a-7c87-4afe-accc-aba60622261f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9b287f4f-54d0-485d-b591-c971c78f2ab3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "273bb581-fcab-41c7-83c6-cbcbd9087047",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaa6cd29-2e3a-405a-98e7-3d79f7ed54fe",
"db_currency_id": "6b8c902b-2d70-4d3c-8d0a-50682e8b573c",
"db_language_id": "6003a4a1-48ad-457c-9fc1-e63be7eecf31",
"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-28T02:43:30.5026604+00:00"
},
"modified_dateutc": "2026-02-28T02:43:30.5026604+00:00"
},
"marketing_segment_id": "11df64a0-2d2a-4a8c-9c59-a7b6ec37dbb0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a5f4b8ea-e150-458f-837f-422b17f084df",
"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": "c8d8bfc0-b252-4b80-84f5-ad26d451f87d",
"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": "71a01074-3f31-4f71-be6e-4ec42436a0d1",
"db_country_code": "sample string 28",
"feelist_id": "a871834e-cb15-447e-bb14-0407901dd8b1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "badbc4fe-0242-4662-b3b8-0fd9a76a431e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "23ee108d-a25e-46cf-b5fd-ffe5a355132a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-28T02:43:30.5026604+00:00",
"db_currency_id": "f7bf2519-175f-4a30-8ea9-d72665e0fca0",
"db_currency_code": "sample string 10"
},
"company_type_id": "965ff2ee-a660-4a5d-9163-db528c3828fa",
"company_type_name": "sample string 32",
"company_type": {
"id": "90627b12-83e0-42cb-8956-8334a859cff2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "05278967-14b0-4949-bc70-f73d05963666",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6f4c4415-4de9-4745-8616-aa4907938c11",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3813022b-f28a-4d82-a9ab-401914ef06d4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5f277840-c702-43ec-8916-22aca65cb19f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "180fee79-88a6-4e32-9041-94ec0095040a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-28T02:43:30.5026604+00:00"
},
"company_sector_id": "81a492d0-5a00-4f85-b0f3-456d6c83efce",
"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": "d7857692-2a77-4a86-a6ba-85996bd2ba37",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "80d118c3-5edc-413b-9185-ca3dc678192b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "848cb60f-eb40-4f51-b424-ebe1fd0aedcc",
"account_manager_user_code": "sample string 56",
"company_status_id": "02e5b740-9413-4e50-aa77-1722b0ce0ecc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-28T02:43:30.5026604+00:00",
"id2": 60
},
"db_language_id": "9d068bff-83c7-4b27-bbb3-79e33ceb7365",
"db_language_code": "sample string 7",
"db_title_id": "91159a2e-0e25-45aa-8150-00a65c7f32e4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-28T02:43:30.5026604+00:00",
"create_date": "2026-02-28T02:43:30.5026604+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-28T02:43:30.5026604+00:00"
}