Contacts

Retrieve all contacts.

Get a paginated list of contacts.

get/contacts

Request

  • Base URL: https://api.floorworks.co.uk/api/v1
  • URL: https://api.floorworks.co.uk/api/v1/contacts
  • Auth: OAuth 2 (password, token URL https://api.floorworks.co.uk/api/v1/auth)

Query parameters

srch_contactstring uuid

ID of the contact that is associated with this document.

srch_status0 | 1 | 2

Search by status. 0 = Inactive, 1 = Active, 2 = On Stop.

srch_type1 | 2 | 3 | 4

Search by contact type. 1 = Client, 2 = Operative, 3 = Supplier, 4 = Contact.

srch_date_fromstring d/m/Y

Search by start date

srch_date_tostring d/m/Y

Search by end date

page_sizenumber

Results per page

pagenumber

Current page

order_direction'DESC' | 'ASC'

Sort results ascending or descending

Response

List of contacts

Example response

[
  {
    "id": 12345,
    "time_created": "2025-08-17",
    "time_modified": "2025-08-18"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.