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": "2f087ff1-463d-4a14-b6e1-b5d969b39e57",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "63dbf85a-8d72-4769-90da-8330adecf443",
"company_code": "sample string 5",
"company": {
"id": "14b4c8ee-696c-4675-a9fb-e7eb49c2c1d0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-09T00:44:40.8509969+00:00",
"sales_territory_id": "3f7ed061-a788-4ef0-aa26-54616542b445",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "27fb3f60-cf83-4dbc-8d13-139ec55a411f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f5506d19-3f62-4309-bafc-a0f58ec0a7b2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "01ba38a6-aee5-4cc0-a061-531b56c45c3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d49f8671-cd28-4491-be26-b9a4b31b044f",
"db_currency_id": "e82771d4-42f7-416c-a496-ad084c3612ce",
"db_language_id": "23a74b39-6181-4b9a-ab85-8c30e4829fe3",
"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-09T00:44:40.8509969+00:00"
},
"modified_dateutc": "2026-07-09T00:44:40.8509969+00:00"
},
"marketing_segment_id": "8fa57918-e6d3-4e2f-937f-5daef10cfc51",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f92a56a3-948d-4f5c-98ae-02c42ac18b7e",
"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": "e0c92357-58bd-49ad-86fd-c85b9d3492e9",
"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": "f2cc0ad1-28c4-4519-abb7-4a42c796fa14",
"db_country_code": "sample string 28",
"feelist_id": "812d1b29-5bbe-4bb4-ace9-0f7d71ea0ade",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c91012ff-0610-43f2-9f3c-5596d7dbd866",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2478d6b0-e89c-4298-8c6f-9dd2bdddd187",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-09T00:44:40.8509969+00:00",
"db_currency_id": "a139dd7f-d4be-4a93-a9a5-061c222cdc17",
"db_currency_code": "sample string 10"
},
"company_type_id": "a79f23c4-5bd6-43b4-a988-bd95923e3842",
"company_type_name": "sample string 32",
"company_type": {
"id": "e458fb1b-8be0-486e-b2f9-7bb1515e897b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "56a9d488-23bf-4f43-9539-2dcdd1627088",
"sales_organization_code": "sample string 5"
},
"db_language_id": "52823170-6375-41d3-849f-e7c5f34b1d14",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5c52c17e-2b8e-4634-afb4-f3b9a2223cf2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4498562b-58d5-411c-8dc2-9a614dda8c7b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c22a5c4e-08b4-47f4-a374-78d242a3abce",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-09T00:44:40.8509969+00:00"
},
"company_sector_id": "e8cd5c93-5fd5-489a-b2c2-fd4ec8da302b",
"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": "a38e9566-8e25-4ca5-8327-5c822287a155",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3ccb506a-60ed-4c8d-b08a-c697a115f6b8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d910cb15-ecee-47e0-a4cb-ee01d444b029",
"account_manager_user_code": "sample string 56",
"company_status_id": "8f721fb2-b1ea-42a2-9213-5c225b2a27c9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-09T00:44:40.8509969+00:00",
"id2": 60
},
"db_language_id": "06319e9c-1039-45a7-a293-68d0d8750dea",
"db_language_code": "sample string 7",
"db_title_id": "c77be499-7259-499c-9133-bc36036fb7c6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-09T00:44:40.8509969+00:00",
"create_date": "2026-07-09T00:44:40.8509969+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-09T00:44:40.8509969+00:00"
}