---
title: "List Beats"
method: GET
path: "/v1/beats"
tags: ["beats"]
---

# List Beats

`GET /v1/beats`

## Request

- Base URL: `https://api.myarchivist.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.myarchivist.ai/v1/beats`
- Auth: HTTP bearer

## Query parameters

- `campaign_id` string, nullable: Campaign ID to filter beats
- `session_id` string, nullable: Session ID to filter beats
- `include_hierarchy` boolean: Return nested beat tree for session_id
- `with_links` boolean: Return descriptions with [[wikilinks]] intact
- `page` integer
- `size` integer

## Headers

- `x-api-key` string, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/myarchivist/apis/archivist-public-api.md) · [All operations](https://skmtc.dev/myarchivist/apis/archivist-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/myarchivist/apis/archivist-public-api/revisions/3ea6ca7efc56?raw)