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": "bdae31f8-f308-4abc-b6b1-42a90ddeb8e4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7325b3a0-5392-4045-82a2-455e717f3a01",
"company_code": "sample string 5",
"company": {
"id": "5e12bed4-0990-41c0-b1e4-a449b061feee",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-16T11:31:18.1278007+00:00",
"sales_territory_id": "a99611f6-7987-4f99-8fa1-c97bb093a8b0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dbb0f653-0d81-43a0-9f78-9611bc3923f9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "451e41bb-f59c-41eb-b827-494267b31e0f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "509346ee-9464-4974-843e-38c0ee8c6a2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0156305-b962-4450-b2d8-dd18be778b64",
"db_currency_id": "b9603fac-4f8a-4e78-973a-f33594afd5e1",
"db_language_id": "c421adc5-9a7d-4310-92f1-7effccbaa0ee",
"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": "2025-09-16T11:31:18.1278007+00:00"
},
"modified_dateutc": "2025-09-16T11:31:18.1278007+00:00"
},
"marketing_segment_id": "79079992-0286-45c6-8b79-8bd4aee82e90",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "550bdabc-c9d3-4c13-a9e6-4045c56a2d4b",
"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": "7c1d2408-d008-42a8-9360-1bb213598e60",
"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": "349355c3-a7ca-44fe-bec2-638e55195d1c",
"db_country_code": "sample string 28",
"feelist_id": "c0307bd1-8bc6-4b9d-beec-a6ada2735367",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bc0849f8-e777-41a3-a21a-c9934dd496f6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "277411cd-e563-4c62-aa8a-a43f271045cf",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-16T11:31:18.1278007+00:00",
"db_currency_id": "15d15324-f0f5-4bb2-a58a-6c0dde6d11c5",
"db_currency_code": "sample string 10"
},
"company_type_id": "6bbdb29c-f6e3-45c7-a720-a0a69be846d2",
"company_type_name": "sample string 32",
"company_type": {
"id": "3f0d189c-5e63-46f7-96b5-0cc6891e08fa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4a4b39d1-9acd-45b0-af60-9df08884875f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7d2b9dec-0993-4aa4-87bb-8c756eca8f55",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ce1c81a9-dbf7-4a77-8949-87b2a2c2e391",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "aae4bcc1-8067-49b1-86fe-808636efe612",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9c1ea503-5830-4cb5-a7bd-6e4ca61bf012",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-16T11:31:18.1278007+00:00"
},
"company_sector_id": "815f4b22-c977-486b-9f56-d77c780834a8",
"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": "9fb3c07d-03a4-4af9-8b2e-72aff5816243",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e06fd5c2-f6b0-4abe-ba7e-ab7ce1391e5f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9d538b81-1282-4695-9a6a-34b277fd426d",
"account_manager_user_code": "sample string 56",
"company_status_id": "76a2ef8f-d6c4-4906-8d8d-8ee79a039be4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-16T11:31:18.1278007+00:00",
"id2": 60
},
"db_language_id": "5f4e9245-b0fd-4552-a77a-a165fa9783f7",
"db_language_code": "sample string 7",
"db_title_id": "d33742b4-7602-4cea-b6f6-45bf162b8160",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-16T11:31:18.1278007+00:00",
"create_date": "2025-09-16T11:31:18.1278007+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": "2025-09-16T11:31:18.1278007+00:00"
}