---
title: "List team permission definitions"
method: GET
path: "/team-permission-definitions"
tags: ["Permissions"]
---

# List team permission definitions

`GET /team-permission-definitions`

Query and filter the permission with team_id, user_id, and permission_id (the equivalent of listing permissions on the Hexclave dashboard)

## Query parameters

- `limit` integer — Maximum number of items to return (capped at 200). When set, the response is paginated via cursor.
- `cursor` string — Cursor (permission id) to start the next page from. Requires `limit` to also be set.
- `query` string — Free-text filter applied to permission id and description (case-insensitive).

## Response `200`

Successful response

- object
  - `items` object[], required
    - `id` string, required — The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, `:`, and `_` characters, or one of the system permissions: `$update_team`, `$delete_team`, `$read_members`, `$remove_members`, `$invite_members`, `$manage_api_keys`
    - `description` string — A human-readable description of the permission
    - `contained_permission_ids` string[], required — The IDs of the permissions that are contained in this permission
  - `pagination` object
    - `next_cursor` 'null', nullable — The cursor to fetch the next page of results. null if there is no next page.

---

[API](https://skmtc.net/hexclave/apis/hexclave-rest-api-3.md) · [All operations](https://skmtc.net/hexclave/apis/hexclave-rest-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hexclave/hexclave-rest-api-3/versions/690014f63028/schema)
