Skip to main content
GET
/
v1
/
loyalty
/
residents
List all residents
curl --request GET \
  --url https://api.yorlet.com/v1/loyalty/residents \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "resident",
      "building": "<string>",
      "email": "<string>",
      "name": "<string>",
      "tier": "<string>",
      "status": "active",
      "account": "<string>",
      "deleted": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A dictionary with a data property that contains an array of up to limit residents. Each entry in the array is a separate resident object. If no more residents are available, the resulting array will be empty.

​
count
number
required

Total number of items in the list.

Example:

1

​
has_more
boolean
required

Whether more items are available.

Example:

false

​
object
enum<string>
required
Available options:
list
​
data
object[]
required