List Property Groups

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

{
  "name": "name",
  "createdAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "description": "description",
  "id": "id",
  "idempotencyId": "idempotencyId",
  "organizationId": "organizationId",
  "properties": [
    {
      "name": "name",
      "shortName": "shortName",
      "email": "email",
      "phone": "phone",
      "physicalStreetAddress1": "physicalStreetAddress1",
      "physicalStreetAddress2": "physicalStreetAddress2",
      "physicalCity": "physicalCity",
      "physicalState": "physicalState",
      "physicalZip": "physicalZip",
      "physicalCountry": "physicalCountry",
      "mailingStreetAddress1": "mailingStreetAddress1",
      "mailingStreetAddress2": "mailingStreetAddress2",
      "mailingCity": "mailingCity",
      "mailingState": "mailingState",
      "mailingZip": "mailingZip",
      "mailingCountry": "mailingCountry",
      "phoneNumber": "phoneNumber",
      "faxNumber": "faxNumber",
      "timezone": "timezone",
      "longitude": 1.1,
      "latitude": 1.1,
      "turnMoveOutDays": 1,
      "organizationId": "organizationId",
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "offboardedAt": "2024-01-15T09:30:00Z",
      "countyName": "countyName",
      "acquisitionDate": "2024-01-15T09:30:00Z"
    }
  ],
  "propertyIds": [
    "propertyIds"
  ],
  "readableId": "readableId",
  "updatedAt": "2024-01-15T09:30:00Z"
}

List all property groups

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 property groups

namestring

createdAtdatetime

deletedAtdatetime

descriptionstring

idstringformat: "uuid"

idempotencyIdstringformat: "uuid"

organizationIdstringformat: "uuid"

propertieslist of objects

propertyIdslist of strings

readableIdstring

updatedAtdatetime