Appointments
Mobile

Retrieve all appointments.

Get a list of all appointments.

get/staff/appointments

Request

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

Query parameters

order_field'id' | 'appointed' | 'created' | 'contact' | 'property'

Field to sort results by.

srch_contactstring uuid

ID of the contact that is associated with this document.

srch_propertystring uuid

ID of the property that is associated with this document.

srch_userstring uuid

ID of the user who created this document.

srch_appointed_frominteger

Filter appointments on or after this date (Unix timestamp).

srch_appointed_tointeger

Filter appointments on or before this date (Unix timestamp).

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 all appointments

Example response

[
  {
    "time_appointed": 1755388800,
    "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.