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": "d19953b1-9faf-4913-ac2c-c2a0980ca9f1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9321b65e-c2a7-4e36-afb5-0304abffabfd",
"company_code": "sample string 5",
"company": {
"id": "27f381ce-dd62-4619-bf81-df1ccccef1bf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-05T18:05:00.9175195+00:00",
"sales_territory_id": "18901b9f-bac4-426f-8b91-7993372e6bae",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0f4ffb83-bcd7-4dfa-be72-991468a11f36",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "50ad6717-c9f2-428b-8f51-5f3923a94939",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5d724126-6b91-4004-81f6-2250929eb585",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1596ac41-8e0e-4343-983f-b1d4dd6b5ed6",
"db_currency_id": "78cf3168-5ecc-4578-8a85-27e3a3f67e0a",
"db_language_id": "84dcfc27-2ba2-4290-8c0a-1c6f886fc280",
"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-06-05T18:05:00.9175195+00:00"
},
"modified_dateutc": "2026-06-05T18:05:00.9175195+00:00"
},
"marketing_segment_id": "693e8550-4df6-4f58-9a41-bc05cd3f0652",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "773f6fc4-b3ed-4540-8d56-77556385a299",
"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": "7eabd6fd-e009-4286-bb1f-d973249a3755",
"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": "de3ca1ac-3c37-45e9-aa7d-7359e2c8cda9",
"db_country_code": "sample string 28",
"feelist_id": "73d89f69-3d01-442b-89b4-e0f975d2c1bc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b05928a9-c73d-4702-80f8-75089a02173f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "28a36045-af60-4d8e-910e-4116b01aad36",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-05T18:05:00.9175195+00:00",
"db_currency_id": "b5ee8655-6376-4d16-841d-d9234c3823de",
"db_currency_code": "sample string 10"
},
"company_type_id": "dc578056-4416-4c0c-a549-e3ca9afaa9c7",
"company_type_name": "sample string 32",
"company_type": {
"id": "3b9576d4-13c2-4ad5-9695-380a3834d43f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ad5fa61b-9f3b-40b8-8c9e-d79bbdc69e07",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f20f096e-22e0-456a-8f2e-0a625b4737d6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a27ce0e7-2b8e-41be-a373-a29e5afbe460",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4181b40a-f14a-4e2c-b10e-f915865d68ed",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4463a6b8-4daf-44c6-8070-44db5706c022",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-05T18:05:00.9175195+00:00"
},
"company_sector_id": "5195a9a2-4d2f-489b-9a86-8a8174a43857",
"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": "68e357bb-eb52-40d1-83bf-a47e4f05aebc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f23067a3-a4d3-4494-b6c0-cc731a4746da",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ed81629b-7cce-4f7a-9d13-dfe35069c575",
"account_manager_user_code": "sample string 56",
"company_status_id": "1e6aaad2-c23a-4485-a869-5c728f253e3e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-05T18:05:00.9175195+00:00",
"id2": 60
},
"db_language_id": "bb94e8e1-6b5d-4196-9e99-de971e49ef09",
"db_language_code": "sample string 7",
"db_title_id": "a0c9419b-41ce-4b47-ba85-22bf01dc86d4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-05T18:05:00.9175195+00:00",
"create_date": "2026-06-05T18:05:00.9175195+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-06-05T18:05:00.9175195+00:00"
}