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": "5f4af5bc-499e-451e-857a-8796150f7f55",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3691a34c-f7a5-40af-b4c4-ff66eadb6253",
"company_code": "sample string 5",
"company": {
"id": "1a8d01bc-ab77-476b-bcf1-5a3d49e0d68a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-18T13:42:54.928916+00:00",
"sales_territory_id": "71335695-6b67-42d7-8a6f-a0e63d9950c2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "eb0d48a1-076e-438d-b28f-1e5ca90c9ab3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "09ebb9a7-0bb2-4395-a099-5b326abbd7b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3d5fe2b1-4bc6-4217-9ce0-10b6a34a524a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e2edf4e-020d-4d7e-acb9-ad5cebbdf2c2",
"db_currency_id": "63ccd943-e920-4870-9027-a12fbbb901dd",
"db_language_id": "6f509324-2aed-4137-8936-c39ec24aa9bd",
"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-11-18T13:42:54.9445385+00:00"
},
"modified_dateutc": "2025-11-18T13:42:54.9445385+00:00"
},
"marketing_segment_id": "32b3fb29-66c1-4b89-993e-204ae61d48d9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "eb16cf15-b610-4040-ac27-18e8c2d0c648",
"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": "490a2299-ea24-4ac4-bed9-2342cbe01834",
"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": "5563b4c5-6a9f-4425-b7d2-af55bd8625c7",
"db_country_code": "sample string 28",
"feelist_id": "68e5794b-bde4-48d5-bfac-cf25b0b8101c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "055279c3-eaec-441b-b33a-097c51f4f42d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "102b9624-f82c-463f-bb21-c4bae1ccde4f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-18T13:42:54.9445385+00:00",
"db_currency_id": "05fbab51-9e60-4513-8f83-bf15fe249f9d",
"db_currency_code": "sample string 10"
},
"company_type_id": "10c9e656-9c2c-4150-b586-bcb323ca52bd",
"company_type_name": "sample string 32",
"company_type": {
"id": "1ca10de2-c8d7-4e18-8ddc-738516a1cd2a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d2f191a4-c93e-4f4a-a6cf-c1995a4a0174",
"sales_organization_code": "sample string 5"
},
"db_language_id": "423c09a6-d03b-44fa-9299-697a0c330731",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "338675f8-8340-4fdf-bed6-cbd622e9d81d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fb67710f-a69a-40f0-9705-530d175a5a1b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4525d619-9860-4e88-8b04-ddda5cc50e39",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-18T13:42:54.9445385+00:00"
},
"company_sector_id": "22c1e3a5-cc88-41f1-947d-97c6f5daadd0",
"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": "078045b4-43a2-4843-ba37-07ad53715c10",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "97c2e15f-75fa-42c8-828c-369e98c7b8a2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "478dc94f-4797-4aba-8791-4a81f96c7ae0",
"account_manager_user_code": "sample string 56",
"company_status_id": "22849e26-af11-4c6c-8004-2202969162f3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-18T13:42:54.9445385+00:00",
"id2": 60
},
"db_language_id": "37010efb-d9c4-4e9d-b2e9-1db19baeab4f",
"db_language_code": "sample string 7",
"db_title_id": "cd80c6cd-3416-4522-bab7-7ece45e6d3cf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-18T13:42:54.9445385+00:00",
"create_date": "2025-11-18T13:42:54.9445385+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-11-18T13:42:54.9445385+00:00"
}