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": "0c42cd2a-75a4-49ef-bebf-5e99cf4e7493",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8a480426-b170-4b07-af33-9343fdbbdac8",
"company_code": "sample string 5",
"company": {
"id": "4ee83400-bed5-4562-9236-013c292fe165",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-19T05:21:32.2790762+00:00",
"sales_territory_id": "11ac74cb-9ab7-48a8-b034-888cd58fc69e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "15467bcb-e985-4e79-ad26-360c0b80dc9b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a73d4255-486a-4f67-bb02-7ec5f23e9f33",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "40009fca-fb36-43a8-bd08-a754ed2e7b3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3b52dd5-9347-47de-8bbf-03fdeaa920ec",
"db_currency_id": "85e14092-6946-42db-bb20-b79c54305b34",
"db_language_id": "f874af8c-f3d2-4942-b4b1-b59f9dd2873f",
"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-02-19T05:21:32.2790762+00:00"
},
"modified_dateutc": "2026-02-19T05:21:32.2790762+00:00"
},
"marketing_segment_id": "cf9fd393-f27c-4779-aa13-78ad2815ba8a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "06d7ecef-4845-4aba-926e-2ddce49e6cc5",
"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": "6e99a1a5-4afc-4ca2-ab0a-72d22a39d61f",
"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": "232a0a7a-2298-4edd-a102-f43b1c82bbd1",
"db_country_code": "sample string 28",
"feelist_id": "38dce42a-5dce-4e85-8914-03c82f3a09d5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cf156f20-749d-4abc-91d1-05716c743778",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "26bc8620-4e78-4b9f-9ce8-f81aef1fa30e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-19T05:21:32.2790762+00:00",
"db_currency_id": "04fcbd8c-1ead-4aa8-bf11-2402c52cd746",
"db_currency_code": "sample string 10"
},
"company_type_id": "b35b0ca4-bd36-4103-b656-4a3752402ea8",
"company_type_name": "sample string 32",
"company_type": {
"id": "811def54-3fc5-4493-816e-ca8b17af0974",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3899f7bd-fe33-415e-b73f-00d8e97e8898",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8847bf84-08ad-40e9-a81a-8e2779648edc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "928f956b-ff9a-4140-95dc-15f26a53b0b4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0cc8ff0c-51ec-46d2-a2d9-d5eec42b443d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cca51820-e285-4060-8d37-c3e53a4d30eb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-19T05:21:32.2790762+00:00"
},
"company_sector_id": "ecc4a95f-2762-4efc-83e6-739ff9f4eb75",
"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": "ca715680-2989-47b4-bc64-6a55c9ef2483",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "24d80519-258f-4071-abf1-794e3b0391f4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bebf2248-e175-43c7-b002-aa51213c81b5",
"account_manager_user_code": "sample string 56",
"company_status_id": "c2a8b63b-782d-4c29-a53f-a036521abd8b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-19T05:21:32.2790762+00:00",
"id2": 60
},
"db_language_id": "02a6381c-f707-48e4-8b3a-cf6b0f219561",
"db_language_code": "sample string 7",
"db_title_id": "f0df0eec-e531-4935-9f97-d944839a05a4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-19T05:21:32.2790762+00:00",
"create_date": "2026-02-19T05:21:32.2790762+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-02-19T05:21:32.2790762+00:00"
}