List organization users in a zone

GET/zones/{zoneId}/members

Lists all organization users in a zone with their roles and metadata. Supports cursor-based pagination.

Path ParametersExpand Collapse

zoneId: string

Query ParametersExpand Collapse

after: optional string

Cursor for forward pagination

before: optional string

Cursor for backward pagination

"expand[]": optional "total_count" or array of "total_count"

Accepts one of the following:

UnionMember0 = "total_count"

UnionMember1 = array of "total_count"

limit: optional number

Maximum number of members to return

minimum1

maximum100

role: optional "zone_manager" or "zone_viewer"

Filter members by role

Accepts one of the following:

"zone_manager"

"zone_viewer"

ReturnsExpand Collapse

items: array of ZoneMember { id, _links, created_at, 5 more }

id: string

Unique identifier of the zone member

_links: object { organization_user, self }

HAL-format hypermedia links for zone member resources

organization_user: object { href }

href: string

Link to the user resource

formaturi-reference

self: object { href }

href: string

Link to this zone member resource

formaturi-reference

created_at: string

Entity creation timestamp

formatdate-time

organization_id: string

Organization ID that owns the zone

organization_user_id: string

Organization user ID of the zone member

role: ZoneRole

Zone role type. zone_manager has full management access, zone_viewer has read-only access.

Accepts one of the following:

"zone_manager"

"zone_viewer"

updated_at: string

Entity update timestamp

formatdate-time

zone_id: string

Zone ID the organization user is a member of

page_info: PageInfoPagination { has_next_page, has_previous_page, end_cursor, start_cursor }

Pagination information

has_next_page: boolean

Whether there are more items after the current page

has_previous_page: boolean

Whether there are items before the current page

end_cursor: optional string

Cursor pointing to the last item in the current page

start_cursor: optional string

Cursor pointing to the first item in the current page

pagination: object { after_cursor, before_cursor, total_count }

Cursor-based pagination metadata

after_cursor: string

An opaque cursor used for paginating through a list of results

minLength1

maxLength255

before_cursor: string

An opaque cursor used for paginating through a list of results

minLength1

maxLength255

total_count: optional number

Total number of items matching the query. Only included when expand[]=total_count is requested.

List organization users in a zone

curl https://api.keycard.ai/zones/$ZONE_ID/members

{
  "items": [
    {
      "id": "id",
      "_links": {
        "organization_user": {
          "href": "href"
        },
        "self": {
          "href": "href"
        }
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "organization_id": "organization_id",
      "organization_user_id": "organization_user_id",
      "role": "zone_manager",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "zone_id": "zone_id"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_previous_page": true,
    "end_cursor": "end_cursor",
    "start_cursor": "start_cursor"
  },
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}

Returns Examples

{
  "items": [
    {
      "id": "id",
      "_links": {
        "organization_user": {
          "href": "href"
        },
        "self": {
          "href": "href"
        }
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "organization_id": "organization_id",
      "organization_user_id": "organization_user_id",
      "role": "zone_manager",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "zone_id": "zone_id"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_previous_page": true,
    "end_cursor": "end_cursor",
    "start_cursor": "start_cursor"
  },
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}