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": "d7ee4762-7f4a-424b-8b4e-07605eaf67c7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "75d96a3c-ec4f-4ff8-a917-4cfe96f34d2f",
"company_code": "sample string 5",
"company": {
"id": "29fde287-7a27-40ba-9f87-2cae927c7d4a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-13T18:09:31.5813416+00:00",
"sales_territory_id": "b9f7fa1c-204f-413d-a377-9097879db693",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "64bc44f2-e6eb-4cb3-bcbb-8e571d59f512",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8059f5c6-f40f-4ddb-a16f-6b675591e91d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "861e376c-9fed-4af5-ab52-1e8e7cabc9d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3eeaa39-3313-48e2-a1a1-579d2d716e17",
"db_currency_id": "3cfc1c75-cf5f-4563-b236-073b1eae4e82",
"db_language_id": "4b5f6235-d486-45f4-8e89-236d42778259",
"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-13T18:09:31.5813416+00:00"
},
"modified_dateutc": "2025-11-13T18:09:31.5813416+00:00"
},
"marketing_segment_id": "1853d7c8-0ea7-4584-b97c-04bc7a56d77a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1dbf6840-7b61-4c4e-8c1e-015386a0fe3b",
"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": "7c3eab9d-9bcb-45ef-8b12-d37fcca73833",
"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": "635e94fb-6f4d-404c-95ad-e4ae0deddf5b",
"db_country_code": "sample string 28",
"feelist_id": "bd147294-4b3a-43d6-96ac-f0157cdf6b65",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c835bac8-a428-4753-925b-95b849c6e790",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1f2f5839-8655-4b58-b982-ef3a96afb65a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-13T18:09:31.5813416+00:00",
"db_currency_id": "72cdc294-4e2c-4f05-96ff-57b605e17cdd",
"db_currency_code": "sample string 10"
},
"company_type_id": "003cc9cd-c5ad-40f9-add7-721f696cf12b",
"company_type_name": "sample string 32",
"company_type": {
"id": "0ec9d77e-6115-4630-be89-6e89fd953eb3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b991d57b-6142-4b09-9d9c-76e0608a4f8c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0224baf1-ba1e-472f-9a3a-2808652148f5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "25a0fe35-c417-4a9c-a4cf-0e7b0939206b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0852ec33-41b0-46d3-98c7-36628d3fd15a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "31d625c2-090d-4827-924f-efb2eb14f7ad",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-13T18:09:31.5813416+00:00"
},
"company_sector_id": "a2cb4651-bd78-4a41-a6dd-cf2563b0106b",
"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": "b0c60866-e908-4a58-961f-8b0171a51bb6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9f73f296-fd8d-404a-a59a-d4a914bd8b51",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "913c5b01-d862-4709-9cbb-8ec1b726bbf8",
"account_manager_user_code": "sample string 56",
"company_status_id": "862993aa-4720-49ca-92a6-7e83147d8d31",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-13T18:09:31.5813416+00:00",
"id2": 60
},
"db_language_id": "671a99f3-899e-4825-9385-1322fe1ede9f",
"db_language_code": "sample string 7",
"db_title_id": "b0a477f4-4e17-4a2b-a139-4b8709d6f1c6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-13T18:09:31.5813416+00:00",
"create_date": "2025-11-13T18:09:31.5813416+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-13T18:09:31.5813416+00:00"
}