Get Corpus Permissions

GET

/api/corpus/{corpus_id}/permissions

Corpus APIs

This endpoint allows authenticated users to retrieve the access permissions associated with a specific corpus.

Response Example

{
    "corpus_id": 123,
    "permissions": [
        "view_corpus",
        "change_corpus"
    ],
    "shared_with": [
        "user1@example.com",
        "user2@example.com"
    ]
}

Request

Path Params

corpus_id

integer

required

The ID of the corpus to retrieve permissions for.

Responses

🟢200OK

application/json

Permissions retrieved successfully.

Body

corpus_id

integer

optional

The ID of the corpus.

Example:

123

permissions

array[string]

optional

A list of permissions assigned to the corpus.

Example:

["view_corpus","change_corpus"]

shared_with

array[string]

optional

A list of users with permissions for the corpus.

Example:

["user1@example.com","user2@example.com"]

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Delete Corpus

Create Corpus Permissions