Surveys

Search surveys.

Search surveys by reference or contact.

get/surveys/search

Request

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

Query parameters

searchstring required

Search query string.

Response

Matching surveys

statusstring nullable

Survey status code (see /surveys/statuses for available values).

parent_idinteger nullable

ID of the parent record (for child/linked entries).

property_idstring uuid

Property Id.

contact_idstring uuid

ID of the contact that is associated with this document.

manager_contact_idstring uuid

Manager Id.

surveyor_idstring uuid nullable

ID of the surveyor assigned to this survey.

department_idnumber

Department Id.

probabilityinteger nullable

Probability of conversion (0–100).

time_bookinginteger

Booking time.

time_slotinteger nullable

Estimated duration of the survey slot in minutes.

survey_schemasstring nullable

JSON array of survey schema/template references.

service_idstring uuid nullable

ID of the associated work order / service.

quote_idstring uuid

Quote Id.

team_idinteger nullable

ID of the assigned team.

project_idstring uuid nullable

ID of the associated project.

task_idinteger nullable

ID of the associated task.

vatinteger nullable

VAT rate percentage.

referencestring

Auto generated reference of the document.

idnumber

ID.

uuidstring uuid

UUID.

time_createdstring YYYY-MM-DD

Creation date

time_modifiedstring YYYY-MM-DD

Last modification date

Example response

[
  {
    "time_booking": 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.