List Property Groups

GET

https://api.fortresstech.io/v1/propertyGroups

GET

/v1/propertyGroups

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

200Retrieved

1 {
2   "name": "name",
3   "createdAt": "2024-01-15T09:30:00Z",
4   "deletedAt": "2024-01-15T09:30:00Z",
5   "description": "description",
6   "id": "id",
7   "idempotencyId": "idempotencyId",
8   "organizationId": "organizationId",
9   "properties": [
10     {
11       "name": "name",
12       "shortName": "shortName",
13       "email": "email",
14       "phone": "phone",
15       "physicalStreetAddress1": "physicalStreetAddress1",
16       "physicalStreetAddress2": "physicalStreetAddress2",
17       "physicalCity": "physicalCity",
18       "physicalState": "physicalState",
19       "physicalZip": "physicalZip",
20       "physicalCountry": "physicalCountry",
21       "mailingStreetAddress1": "mailingStreetAddress1",
22       "mailingStreetAddress2": "mailingStreetAddress2",
23       "mailingCity": "mailingCity",
24       "mailingState": "mailingState",
25       "mailingZip": "mailingZip",
26       "mailingCountry": "mailingCountry",
27       "phoneNumber": "phoneNumber",
28       "faxNumber": "faxNumber",
29       "timezone": "timezone",
30       "longitude": 1.1,
31       "latitude": 1.1,
32       "turnMoveOutDays": 1,
33       "status": "ACTIVE",
34       "propertyClass": "Conventional",
35       "organizationId": "organizationId",
36       "id": "id",
37       "readableId": "readableId",
38       "idempotencyId": "idempotencyId",
39       "createdAt": "2024-01-15T09:30:00Z",
40       "updatedAt": "2024-01-15T09:30:00Z",
41       "deletedAt": "2024-01-15T09:30:00Z",
42       "offboardedAt": "2024-01-15T09:30:00Z",
43       "countyName": "countyName",
44       "acquisitionDate": "2024-01-15T09:30:00Z"
45     }
46   ],
47   "propertyIds": [
48     "propertyIds"
49   ],
50   "readableId": "readableId",
51   "updatedAt": "2024-01-15T09:30:00Z"
52 }

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

createdAtdatetimeOptional

deletedAtdatetimeOptional

descriptionstringOptional

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

propertieslist of objectsOptional

propertyIdslist of stringsOptional

readableIdstringOptional

updatedAtdatetimeOptional