List access bindings

Requires admin+ (or owner).

GET /v1/knowledge_bases/{knowledgeBaseId}/access

List access bindings

cURL

curl --request GET \
  --url https://{host}/v2/workspaces/slug:storage/webhooks/v1/knowledge_bases/{knowledgeBaseId}/access \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "object": "list",
  "data": [
    {
      "object": "knowledge_base.access_binding",
      "knowledge_base_id": "<string>",
      "principal_type": "user",
      "principal_id": "<string>",
      "role": "owner",
      "created_at": 123,
      "email": "<string>",
      "org_slug": "<string>",
      "granted_by": "<string>",
      "updated_at": 123
    }
  ],
  "total": 1,
  "page": 2,
  "limit": 50,
  "has_more": true
}

Authorizations

Authorization · string · header · required

User session JWT or instance API key (iak_*). Send as Authorization: Bearer <token>.

Path Parameters

knowledgeBaseId · string · required

Knowledge base id. Legacy physical prefix vs_ (the kb_ rename is deferred).

Maximum string length: 128

Pattern: ^vs_[A-Za-z0-9-]+$

Query Parameters

limit · integer · default: 20

Page size. Server clamps to [1, 100] silently.

Required range: 1 <= x <= 100

page · integer · default: 1

1-based page number.

Required range: x >= 1

Response

200

application/json

Paginated bindings.

Shared list-response envelope. Array is always data. Every element carries its own object discriminator.

object · enum<string> · required

Available options: list

data · object[] · required

Hide child attributes

data. object · enum<string> · required

Available options: knowledge_base.access_binding

data. knowledge_base_id · string · required

Pattern: ^vs_[A-Za-z0-9-]+$

data. principal_type · enum<string> · required

Available options: user, group, org, agent

data. principal_id · string · required

Maximum string length: 128

data. role · enum<string> · required

Available options: owner, admin, editor, reader

data. created_at · integer · required

data. email · string | null

Resolved at read time for user principals.

data. org_slug · string | null

data. granted_by · string | null

data. updated_at · integer

total · integer · required

Required range: x >= 0

page · integer · required

Required range: x >= 1

limit · integer · required

Required range: 1 <= x <= 100

has_more · boolean · required