> For the complete documentation index, see [llms.txt](https://intuitem.gitbook.io/ciso-assistant/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://intuitem.gitbook.io/ciso-assistant/api-documentation/api-reference.md).

# API reference

Every endpoint of the CISO Assistant REST API, generated from the OpenAPI specification of the latest release, plus the conventions shared by all of them.

The pages below are generated from the API's OpenAPI specification and refreshed on every release, so they always match the latest version. There is one page per resource, and modules such as EBIOS RM or Privacy group their resources under a parent page. Use the download link on any page to get the full specification for your own tooling (Postman, client generators, and so on).

To authenticate, send a [personal access token](https://intuitem.gitbook.io/ciso-assistant/ai-and-integrations/pat.md) as `Authorization: Token <PAT>`. The [overview](https://intuitem.gitbook.io/ciso-assistant/ai-and-integrations/api.md) covers authentication, allowed IPs and a first request.

## Conventions

These rules apply to every resource, so they are described here once rather than on each page.

### Pagination

List endpoints take `limit` and `offset` and return a `count`, `next`, `previous` and `results` envelope. Follow `next` until it is `null` to read a whole collection. Page sizes and limits are described in [API pagination](https://intuitem.gitbook.io/ciso-assistant/configuration/settings/api-pagination.md).

### Filtering, search and ordering

List endpoints accept their filters as query parameters. Date and number filters take a suffix that sets the comparison:

| Suffix     | Meaning                  | Example                               |
| ---------- | ------------------------ | ------------------------------------- |
| `__gt`     | strictly after / greater | `created_at__gt=2026-01-01T00:00:00Z` |
| `__gte`    | on or after              | `created_at__date__gte=2026-01-01`    |
| `__lt`     | strictly before / lower  | `updated_at__date__lt=2026-07-01`     |
| `__lte`    | on or before             | `updated_at__date__lte=2026-06-30`    |
| `__isnull` | value is missing or not  | `created_at__isnull=false`            |

Add `__date` to compare a timestamp by its day only. Most list endpoints also accept `search` for free-text search and `ordering` to sort, with a leading `-` for descending order (`ordering=-created_at`).

### Sparse fields

`?fields=a,b,c` trims a `GET` response to the listed fields, which keeps large lists light. An unknown field name is rejected with HTTP 400.

### Trailing slash

Always include the trailing slash: `/api/assets/`, not `/api/assets`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://intuitem.gitbook.io/ciso-assistant/api-documentation/api-reference.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
