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": "20a0bc57-e10b-470f-9e9d-6f4ae06bad0d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8c6d38c5-14b5-472c-88a0-5cc9e2d0906c",
"company_code": "sample string 5",
"company": {
"id": "5cbcf455-31af-48c1-ae2c-f0a22e4f2985",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-02T13:39:08.5552601+00:00",
"sales_territory_id": "99a23772-e3ea-40a9-ac56-a3847db61435",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "327fb4aa-0fd8-4229-9ead-4f9cb294d89c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4c8d6eeb-ee58-46ab-bebd-b1318e81b862",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3bf28e68-0233-4e7c-a4f7-d550c473d1b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14cf79cc-9d2c-44f0-90a7-6e3b434ee6de",
"db_currency_id": "1cc24ddf-19e0-4aa2-8655-b6998a0d7557",
"db_language_id": "8323a198-522d-4560-b68b-96a1228e6f5c",
"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-02T13:39:08.5552601+00:00"
},
"modified_dateutc": "2025-09-02T13:39:08.5552601+00:00"
},
"marketing_segment_id": "5f7e10b3-cf95-4b9b-9511-a2c3d3a93ea4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c8778533-f4be-46be-ada5-0ca897617234",
"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": "4c365e40-74df-4b6b-954c-85d5109f41df",
"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": "cb66d319-08f7-4b3d-a611-e8947239310e",
"db_country_code": "sample string 28",
"feelist_id": "116c80b5-d92b-452d-be24-22d6975187b3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "582aca79-503d-4d96-a0e7-e1f16d3a9e6c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a33dc226-f5b2-47d4-ba7b-555564cbdd5e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-02T13:39:08.5552601+00:00",
"db_currency_id": "739e46fa-f8ea-44a2-a32a-8adac7db3403",
"db_currency_code": "sample string 10"
},
"company_type_id": "10fba82e-c907-4bfb-9a30-8b422c7d1cf4",
"company_type_name": "sample string 32",
"company_type": {
"id": "cb2b712c-b48e-4d49-8d48-66e3ae89d9bf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "53598432-e5a5-4a10-b21d-6e5d2b60a0ad",
"sales_organization_code": "sample string 5"
},
"db_language_id": "593b8d3f-d4e3-4f32-b917-134a387c5364",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1ab6d961-4bda-4a65-a96d-0875fb746a92",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5dc781fd-5ff3-42fb-99c6-2e9d87ec7892",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "093b6258-5a56-46cf-8788-02f086b04a1b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-02T13:39:08.5552601+00:00"
},
"company_sector_id": "88353c9f-486f-435d-befd-0f4f72185687",
"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": "e6dc3ed1-28a5-406c-ac2a-96de7b07c1f4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bcdf8a53-5076-43fb-94e4-1df972d3ec0e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f4898e77-2e7c-4318-867c-e5b5e917b83b",
"account_manager_user_code": "sample string 56",
"company_status_id": "86a26e7d-f9b9-44a0-9d11-d27e080c8fac",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-02T13:39:08.5552601+00:00",
"id2": 60
},
"db_language_id": "c1be7ec3-5cfe-4767-9be0-0680bbed0616",
"db_language_code": "sample string 7",
"db_title_id": "61683f30-9e6c-4a41-96bf-137978b91b71",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-02T13:39:08.5552601+00:00",
"create_date": "2025-09-02T13:39:08.5552601+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-02T13:39:08.5552601+00:00"
}