Miscellaneous

To get more detailed information about the contents of the requested/returned representation of resources, see also License, Role and Tag.

GET

GET /api	Get all base API endpoints.
GET /api/info	Get information about the Kadi instance.
GET /api/licenses	Get available licenses.
GET /api/roles	Get all possible roles and corresponding permissions of all resources.
GET /api/tags	Get tags of resources the current user can access.
GET /api/trash	Get deleted resources the current user created.

GET /api

Get all base API endpoints.

Versions: v1 (latest)

Status codes

200 (OK) - Return the API endpoints.

GET /api/info

Get information about the Kadi instance.

Versions: v1 (latest)

Status codes

200 (OK) - Return the information about the Kadi instance.

GET /api/licenses

Get available licenses.

Versions: v1 (latest)

Query parameters

page - The current result page. (Default: 1)

per_page - Number of results per page, limited to a maximum of 100. (Default: 10)

filter - A query to filter the licenses by their title or name.

Status codes

200 (OK) - Return a paginated array of licenses, sorted by title in ascending order.

GET /api/roles

Get all possible roles and corresponding permissions of all resources.

Versions: v1 (latest)

Status codes

200 (OK) - Return the resource roles and permissions.

GET /api/tags

Get tags of resources the current user can access.

Versions: v1 (latest)

Query parameters

page - The current result page. (Default: 1)

per_page - Number of results per page, limited to a maximum of 100. (Default: 10)

filter - A query to filter the tags by their name.

type - A resource type to limit the tags to. One of record or collection.

Status codes

200 (OK) - Return a paginated array of tags, sorted by name in ascending order.

GET /api/trash

Get deleted resources the current user created.

Only the id and identifier of the resources are returned. Additionally, each resource contains its resource type (type), its deletion date (deleted_at) as well as endpoints to restore (_actions.restore) or purge (_actions.purge) the resource.

Versions: v1 (latest)

Required scopes: misc.manage_trash

Query parameters

page - The current result page. (Default: 1)

per_page - Number of results per page, limited to a maximum of 100. (Default: 10)

filter - A query to filter the deleted resources by their identifier.

Status codes

200 (OK) - Return a paginated array of deleted resources, sorted by deletion date in descending order.