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": "5f0605f3-41a9-4048-8d1f-49f58c79a8a4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8bbfde6a-eb76-4b72-a68e-6c2963276e0e",
"company_code": "sample string 5",
"company": {
"id": "2cbf3f87-63bb-4a83-8f2f-d554a2fbc48a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-06T23:08:33.9383748+00:00",
"sales_territory_id": "2cd5db50-74e5-45be-a6e2-8e6eabc0397b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8f1fba91-27f1-4a56-a894-14ea4c854389",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "067b2aa8-2e9e-48bb-b5a8-45cbd52d36f4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "06073e95-b614-4633-8d2d-ecd0fd0f8cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2284976a-5e58-4df1-ac2c-abb377d84702",
"db_currency_id": "eea13251-f328-4930-903f-f47956111c9d",
"db_language_id": "548b396a-110a-4ce9-82da-fbea44146dc8",
"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-03-06T23:08:33.9383748+00:00"
},
"modified_dateutc": "2026-03-06T23:08:33.9383748+00:00"
},
"marketing_segment_id": "9ab53056-ad1e-45bf-b5a0-70fac2c57f65",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dec1af2f-32f2-41f1-9b30-b390d24e122c",
"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": "c9db9387-fae8-4033-82bc-3a3405646cc1",
"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": "5a289955-ac60-4df4-b23a-f7949e6ff08e",
"db_country_code": "sample string 28",
"feelist_id": "edc5568c-c895-4e4b-ad2c-a694c918f2de",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c658e536-063b-4a5d-a6d7-45f82856c4f9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d4334deb-f887-4a0d-aa7c-d3a6af99d0e4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-06T23:08:33.9383748+00:00",
"db_currency_id": "6fdfcde9-32b6-468e-b079-d207d55ed737",
"db_currency_code": "sample string 10"
},
"company_type_id": "da026634-1176-408a-b6bd-9b597a592436",
"company_type_name": "sample string 32",
"company_type": {
"id": "aa058a73-c4a4-4ac0-9196-aedc49507ec6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0bfeebb8-4a05-4961-a5c4-df458eb32a14",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b7916e5a-b0bb-4ea2-a0d7-129041b42cc1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dc07ba7b-badc-4d8a-b262-e4badc020e1a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d5d067d9-ca69-47a3-9194-8f8d86402575",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d62ddc66-f5e3-42ab-a508-09c6874ca2d5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-06T23:08:33.9383748+00:00"
},
"company_sector_id": "4bf7685c-2203-4920-820a-22a7e7563c18",
"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": "ea2643f8-1757-4a3b-8719-5f3dddc1d3d1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "34a3132b-0d86-4d06-a87d-893b516ee256",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2fea136e-1a28-4938-bc2b-c0550cb60474",
"account_manager_user_code": "sample string 56",
"company_status_id": "8def1163-8294-4295-9eae-4ef33e1a9039",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-06T23:08:33.9383748+00:00",
"id2": 60
},
"db_language_id": "a023c660-5e53-4175-9f18-a1349c0b75df",
"db_language_code": "sample string 7",
"db_title_id": "90ce60a2-a9e7-4157-b3f6-ced092fcb075",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-06T23:08:33.9383748+00:00",
"create_date": "2026-03-06T23:08:33.9383748+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-03-06T23:08:33.9383748+00:00"
}