List collection shares

GET

/api/collections/{id}/shares

const url = 'https://firma.company-gpt.com/companygpt/rag/api/api/collections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/shares';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://firma.company-gpt.com/companygpt/rag/api/api/collections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/shares \
  --header 'Authorization: Bearer <token>'

List shares for a collection. Only the collection owner may list shares.

Authorizations

BearerAuth

Parameters

Path Parameters

required

string format: uuid

Collection UUID

Responses

200

List of shares

application/json

Array<object>

A collection share (handlers.ShareResponse)

object

required

string format: uuid

collection_id

required

string format: uuid

type

required

string

Allowed values: user entra_group public

target

required

Email for “user” shares, Entra group ID for “entra_group” shares, empty for “public”

string

targetDisplay

required

Human-readable label (e.g. resolved Entra group name); falls back to “target”

string

role

required

string

Allowed values: viewer admin

created_at

required

string format: date-time

Example

[
  {
    "type": "user",
    "role": "viewer"
  }
]

400

Invalid collection ID

401

Unauthorized

403

Forbidden — only the collection owner may list shares

404

Collection not found