API ReferenceApplications

List Applications

List all applications

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.
sortstringOptionalformat: "^([a-zA-Z]+(:(asc|desc)+)?,?)+$"

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0
the page number when used with pagination, defaults to 0
limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

formatenumOptionalDefaults to JSON
The format of the response
Allowed values:

Response

A paged array of applications
applicantobject or null
applicantIdstring or nullformat: "uuid"
assignedUnitIdstring or nullformat: "uuid"
assignedUserIdstring or nullformat: "uuid"
createdAtdatetime or null
deletedAtdatetime or null
householdobject or null
householdIdstring or nullformat: "uuid"
householdslist of objects or null
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
leaseobject or null
leaseIdstring or nullformat: "uuid"
notesstring or null<=2000 characters
organizationIdstring or nullformat: "uuid"
primaryFormCompletedAtdatetime or null
Timestamp of the last completed primary form for any applicant.
propertyobject or null
propertyIdstring or nullformat: "uuid"
readableIdstring or null
secondaryFormCompletedAtdatetime or null
Timestamp of the last completed secondary form for any applicant.
statusenum or null
submittedAtdatetime or null
unitobject or null
updatedAtdatetime or null
userobject or null