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": "0f5c2883-b101-4e40-8509-913be5dc7246",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "22c744ae-a54e-44eb-a3fe-8fafc1544210",
"company_code": "sample string 5",
"company": {
"id": "11aba1a2-08b7-4fca-a79c-296871f14d6e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-30T04:18:15.7817864+00:00",
"sales_territory_id": "da392fd0-c6c3-477a-9172-9cd14e5773e3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4d9b9cc2-49b6-473e-9294-713ee2acc643",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7e3420c7-9dc6-4a7a-9ba1-8e103a429456",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0667d758-6638-465b-a665-a9a14c5511d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b92094-b39f-439b-829a-d976dcc1e884",
"db_currency_id": "a98c0161-b4e1-4ca6-a4aa-f308a23c3d01",
"db_language_id": "47e0572e-4b12-4101-8bf6-a49fcd024277",
"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-12-30T04:18:15.7817864+00:00"
},
"modified_dateutc": "2025-12-30T04:18:15.7817864+00:00"
},
"marketing_segment_id": "f300fc5e-faba-489e-be6b-c1e99de6460d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ad6721d6-a3fb-49a3-a5dc-2917748db5ca",
"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": "8935e21a-2d4c-43d8-9241-896d6075a881",
"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": "f7726803-e203-42e3-9507-9190e19ff7de",
"db_country_code": "sample string 28",
"feelist_id": "98345e25-3e69-4408-9f26-de149ed5d565",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "215c8a9e-3df9-4049-b79b-cfaa44a89ad6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0037d4b6-ae89-4f31-a571-29327e521ab9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-30T04:18:15.7817864+00:00",
"db_currency_id": "b7650220-863d-465a-9afb-fed7708d0aec",
"db_currency_code": "sample string 10"
},
"company_type_id": "04accc36-9313-4083-a4ec-542629cf4c27",
"company_type_name": "sample string 32",
"company_type": {
"id": "70089c86-afc4-415d-b9b8-4bad68b33e20",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0ec53657-bcfb-4256-9aa6-dbda9a817fd1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "953e8770-a541-4bc7-a3ab-07f8cbc994dc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "359e6a13-cec6-434e-aadf-06225a48a9c9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fd517b8a-506a-45f1-b5b6-960eb604c89c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4d79c38d-00cb-4aca-b76e-29b3665addd5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-30T04:18:15.7817864+00:00"
},
"company_sector_id": "b24ed4f8-39f6-4700-8acf-ab4478c148ff",
"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": "6df21076-ff18-433f-ae9f-d259de10df75",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "52def263-bb12-440f-82a5-b877d02e4ca8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "155133b4-cfb8-415d-8b9f-a2e4d959163d",
"account_manager_user_code": "sample string 56",
"company_status_id": "7d12ef5d-84b3-42c1-8814-57ade550a888",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-30T04:18:15.7817864+00:00",
"id2": 60
},
"db_language_id": "21757b5d-4b97-48ea-92f0-aaadc32817b4",
"db_language_code": "sample string 7",
"db_title_id": "82374f2f-d972-4a29-bc78-55d92a1e78e4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-30T04:18:15.7817864+00:00",
"create_date": "2025-12-30T04:18:15.7817864+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-12-30T04:18:15.7817864+00:00"
}