Get List of Property Users API

List property users

get

/property_users

List the users of one property. filter[property_id] is required. Not paginated.

Authorizations

user-api-keystringRequired

API key for programmatic access, sent in the user-api-key header.

Query parameters

filter[property_id]string · uuidRequired

UUID of the property whose users to list.

Example: 716305c4-561a-4561-a187-7f5b8aeb5920

Responses

200

The request has succeeded.

application/json

A plain data-array envelope without pagination — used by reference/dictionary endpoints.

401

Authentication credentials are missing or invalid.

application/json

422

The request has missing or invalid arguments; details lists the messages per argument.

application/json

get/property_users

GET /api/v1/property_users?filter[property_id]=716305c4-561a-4561-a187-7f5b8aeb5920 HTTP/1.1
Host: app.channex.io
user-api-key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "type": "property_user",
      "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
      "attributes": {
        "id": "776533f2-c10e-49d8-bddc-14b3e27c2a00",
        "user_id": "c9cfa184-5095-4ef2-bbe2-e723ffb49184",
        "property_id": "52397a6e-c330-44f4-a293-47042d3a3607",
        "role": "owner",
        "overrides": {}
      },
      "relationships": {
        "property": {
          "data": {
            "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
            "type": "property"
          }
        },
        "user": {
          "data": {
            "type": "user",
            "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
            "attributes": {
              "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
              "name": "Channex User",
              "email": "[e-mail]"
            }
          }
        }
      }
    }
  ]
}