Skip to main content
GET
List memories

Authorizations

Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Headers

X-Hyperspell-Response-Profile
enum<string>
default:api

Response budget for the items array, including requested bodies: lowercase api scales with page size; lowercase mcp uses 256 KiB. Each record is limited to 32 KiB. Values are case-sensitive.

Available options:
api,
mcp
X-As-User
string | null

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Query Parameters

collection
string | null

Filter documents by collection.

source
enum<string> | null

Filter documents by source.

Available options:
reddit,
notion,
slack,
google_calendar,
google_mail,
imap,
google_meet,
box,
dropbox,
github,
gitlab,
google_drive,
vault,
web_crawler,
trace,
microsoft_outlook,
microsoft_teams,
granola,
fathom,
fireflies,
figma,
linear,
hubspot,
salesforce,
coda,
confluence,
jira,
metabase,
gong,
clickup,
lightfield,
pylon,
fellow,
odoo,
external_mcp,
page
status
enum<string> | null

Filter documents by status.

Available options:
pending,
processing,
completed,
failed,
pending_review,
skipped,
filtered,
cancelled
filter
string | null

Filter documents by metadata using MongoDB-style operators. Example: {"department": "engineering", "priority": {"$gt": 3}}

include_chunks
integer
default:0

When > 0, include up to this many extracted memories (chunks with summaries) per document in each item's chunks field, in document order. 0 (default) omits them.

Required range: 0 <= x <= 10
include_body
boolean
default:false

Include document bodies where supported. Slack and Teams entries remain bounded envelopes; use GET /memories/get/{source}/{resource_id} for paginated channel content. File previews stay excluded. Other documents may include a bounded stored preview; use the same point read for larger content.

cursor
string | null
size
integer
default:50
Required range: 0 <= x <= 100

Response

Successful Response

items
DocumentResponse · object[]
required
next_cursor
string | null
required
notices
ResponseContentLimitedNotice · object[] | null