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": "2260c27d-c38b-4e34-a806-d5210973d22b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "761ba7ed-a3d3-4e5a-9107-2cc5762c0005",
"company_code": "sample string 5",
"company": {
"id": "14b73746-5d99-4abe-9107-f818efdca0a3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-12T23:22:10.6858599+00:00",
"sales_territory_id": "c9816418-112b-4c4f-b2f8-8b76b2ab5dc9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8334b843-1abf-4a33-8781-4cdf805d8ce7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c9827860-921d-4896-a966-f784898f9363",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6271133e-a186-4303-b282-c5f3be12f1a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "51fdd353-567f-4eed-95b2-21faaf6a43e6",
"db_currency_id": "ff37f25a-325f-40ab-a710-8fb46ac97aad",
"db_language_id": "6e2a06ae-d800-4d0a-a524-94e2e30f5b19",
"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-12T23:22:10.6858599+00:00"
},
"modified_dateutc": "2026-07-12T23:22:10.6858599+00:00"
},
"marketing_segment_id": "b07e4517-0399-4935-8b9c-1eb0ed3624f8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7e4438b9-b518-4d1a-9cba-44fb1eae1569",
"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": "e22ffcb7-e900-4d09-b262-669d492b36a5",
"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": "cb17667f-c0f6-454d-88cb-49b57f0df392",
"db_country_code": "sample string 28",
"feelist_id": "f6949b00-edb8-4d7e-ae80-bf9ba636283a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0e102680-f804-4089-8a6c-210673b3650d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "afafaa92-e4eb-4988-ba8e-35d284f20450",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-12T23:22:10.6858599+00:00",
"db_currency_id": "7bc486fe-602e-41a1-ba64-a3b270cef1a5",
"db_currency_code": "sample string 10"
},
"company_type_id": "fd3b7a43-9ca9-41c3-b071-d5f268a73ef3",
"company_type_name": "sample string 32",
"company_type": {
"id": "fe35d619-a580-4393-ad9a-e56f38a019e7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1e9a7029-c16b-44f8-9d26-9e6cb6471c41",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9425fcff-9659-437d-8b94-fcffa9c5d0db",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "40a9abae-f88a-4961-a53b-2d587fe0a67c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "27f27532-1a9e-4a53-a898-c3bd9f0dc7f8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "53c9dda1-d2b7-4f5a-b23a-e181fa62ecf1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-12T23:22:10.6858599+00:00"
},
"company_sector_id": "f0830756-68d9-4c4c-a3e9-2885cc2d0778",
"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": "7f0dae2b-fcf6-4581-87b8-cc9f27486d36",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b8ce7916-f253-4a44-a7fd-c3d50a448d11",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9ea76e5a-953a-4433-b727-69dc3ded6537",
"account_manager_user_code": "sample string 56",
"company_status_id": "2697efdd-cf7a-4aee-bd33-75a53e579bc1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-12T23:22:10.6858599+00:00",
"id2": 60
},
"db_language_id": "86b2979a-0bb7-4cfb-8432-9125aa2a8c8e",
"db_language_code": "sample string 7",
"db_title_id": "904d9d3b-f0a3-465a-9e98-598709eb2cdf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-12T23:22:10.6858599+00:00",
"create_date": "2026-07-12T23:22:10.6858599+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-12T23:22:10.6858599+00:00"
}