API ReferenceUsers

List Users

List all users

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)

Response

A paged array of transactions
activitieslist of objects or null
applicationslist of objects or null
createdAtdatetime or null
deletedAtdatetime or null
emailstring or null
firstNamestring or null
hasAllPropertiesboolean or null
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
lastNamestring or null
organizationIdstring or nullformat: "uuid"
propertyIdsstring or null

Comma-separated list of property UUIDs

prospectslist of objects or null
readableIdstring or null
statusenum or null
Allowed values:
updatedAtdatetime or null
userPropertieslist of objects or null
usernamestring or null
workOrderslist of objects or null