List forms

GET

/forms

The forms end point will return a list of forms that have been completed against jobs. This only returns forms built inside the Custom forms setting. Legacy forms will not be returned in this API.

Request

Query Params

Responses

🟢200Success

application/json

Headers

Bodyapplication/json

🟠429429 Too many requests

🟠401401 Unauthorised

🟠403403 Forbidden

🟠404404 Not found

🟠409409 Conflict

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff '/forms?createdByType=undefined&createdByID=undefined&createdOnDateTime[gte]=undefined&lastUpdatedOnDateTime[gte]=undefined&formCategory=undefined&formNameID=undefined&propertyID=undefined&jobID=undefined'

Response Example

200 - Example 1

{
    "meta": {
        "totalRecords": "string",
        "serverTime": "2019-08-24T14:15:22.123Z"
    },
    "pagination": {
        "hasMore": "string",
        "nextCursor": "string",
        "prevCursor": "string"
    },
    "data": [
        {
            "id": 0,
            "createdOnDateTime": "string",
            "lastUpdatedOnDateTime": "string",
            "createdByType": "string",
            "createdByID": "string",
            "createdByUser": "string",
            "propertyID": "string",
            "jobDetails": {
                "jobID": 0,
                "jobDescription": "string",
                "jobAddressLine1": "string",
                "jobAddressLine2": "string",
                "jobAddressLine3": "string",
                "jobTown": "string",
                "jobProvince": "string",
                "jobPostcode": "string"
            },
            "formName": "string",
            "formPDFURL": "string",
            "links": {
                "property": "string",
                "job": "string"
            }
        }
    ]
}

Modified at 2026-09-16 07:43:25

Jobs

Change job stage