List Users

curl -G https://api.fortresstech.io/v1/users \
     --data-urlencode fields=id,name,property.*,documents.type

{
  "activities": [
    {
      "notes": "notes",
      "type": "EMAILED",
      "prospectId": "prospectId",
      "assignedUserId": "assignedUserId",
      "propertyId": "propertyId",
      "organizationId": "organizationId",
      "householdId": "householdId",
      "customerStatus": "customerStatus",
      "startTime": "2024-01-15T09:30:00Z",
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "applications": [
    {
      "notes": "notes",
      "status": "APPROVED",
      "submittedAt": "2024-01-15T09:30:00Z",
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "primaryFormCompletedAt": "2024-01-15T09:30:00Z",
      "secondaryFormCompletedAt": "2024-01-15T09:30:00Z",
      "assignedUserId": "assignedUserId",
      "assignedUnitId": "assignedUnitId",
      "householdId": "householdId",
      "leaseId": "leaseId",
      "applicantId": "applicantId",
      "organizationId": "organizationId",
      "propertyId": "propertyId"
    }
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "email": "email",
  "firstName": "firstName",
  "hasAllProperties": true,
  "id": "id",
  "idempotencyId": "idempotencyId",
  "lastName": "lastName",
  "organizationId": "organizationId",
  "propertyIds": "propertyIds",
  "prospects": [
    {
      "firstName": "firstName",
      "middleName": "middleName",
      "lastName": "lastName",
      "phone": "phone",
      "email": "email",
      "referralSource": "referralSource",
      "propertyId": "propertyId",
      "organizationId": "organizationId",
      "assignedUserId": "assignedUserId",
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "readableId": "readableId",
  "status": "ACTIVE",
  "updatedAt": "2024-01-15T09:30:00Z",
  "userProperties": [
    {
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "userId": "userId",
      "propertyId": "propertyId",
      "organizationId": "organizationId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "username": "username",
  "workOrders": [
    {
      "status": "OPEN",
      "priority": "LOW",
      "hasPetAlert": true,
      "completedAt": "2024-01-15T09:30:00Z",
      "requestorPhone": "requestorPhone",
      "requestorEmail": "requestorEmail",
      "requestedStartDateFrom": "requestedStartDateFrom",
      "requestedStartDateTo": "requestedStartDateTo",
      "requestedStartTimeFrom": "requestedStartTimeFrom",
      "requestedStartTimeTo": "requestedStartTimeTo",
      "dueDate": "dueDate",
      "description": "description",
      "serviceNotes": "serviceNotes",
      "vendorNotes": "vendorNotes",
      "entryNotes": "entryNotes",
      "entryPreference": "24_HOUR_NOTICE",
      "isDoorCodeActive": true,
      "isAlarmActive": true,
      "doorCode": "doorCode",
      "alarmCode": "alarmCode",
      "holdReason": "holdReason",
      "otherLocationDetail": "otherLocationDetail",
      "attachmentIds": "attachmentIds",
      "technicianNotes": "technicianNotes",
      "previouslyReported": true,
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "createdAt",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "assignedUserId": "assignedUserId",
      "householdId": "householdId",
      "customerId": "customerId",
      "unitId": "unitId",
      "maintenanceIssueId": "maintenanceIssueId",
      "maintenanceLocationId": "maintenanceLocationId",
      "propertyId": "propertyId",
      "organizationId": "organizationId",
      "totalCostOfMaterialsUsed": 1.1,
      "totalAmountOwedByResident": 1.1,
      "totalAmountOwedByProperty": 1.1,
      "hourlyServiceRate": 1.1,
      "totalLaborCost": 1.1
    }
  ]
}

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

applicationslist of objects

createdAtdatetime

deletedAtdatetime

emailstring

firstNamestring

hasAllPropertiesboolean

idstringformat: "uuid"

idempotencyIdstringformat: "uuid"

lastNamestring

organizationIdstringformat: "uuid"

propertyIdsstring

Comma-separated list of property UUIDs

prospectslist of objects

readableIdstring

statusenum

Allowed values:

updatedAtdatetime

userPropertieslist of objects

usernamestring

workOrderslist of objects