Skip to main content
GET
List realm attachments
Only realm admins can list them. Any other caller gets a 403 — including an organization admin and an API client, which are scoped to their organizations: they list each organization’s attachments with the organization route instead. Each attachment carries the organizationId it belongs to. Deleted attachments are left out unless status asks for them. Filter by ID, by name or by the automatic summary; a list parameter takes comma-separated values (?status=AVAILABLE,DELETED). Paginated — see Pagination.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

Query Parameters

ids
string[]

Only the attachments with these IDs. Sent but empty, it matches no attachment.


Example (comma-separated list): ?ids=3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e4c60,4bb31747-6c7f-44d2-8e7d-21b1ef129ea6

Maximum array length: 100
name
string

Only attachments whose name contains this text (case-insensitive).

Maximum string length: 256
summary
string

Only attachments whose summary contains this text (case-insensitive).

Maximum string length: 256

Only attachments whose name or summary contains this text (case-insensitive).

Maximum string length: 256
status
enum<string>[]

Only attachments in one of these statuses. Without it, every attachment except the DELETED ones is listed.


Example (comma-separated list): ?status=AVAILABLE,PENDING_UPLOAD

Available options:
PENDING_UPLOAD,
AVAILABLE,
DELETED
next
string

Cursor returned as next by the previous page. Omit for the first page.

limit
integer

Page size, 1–100. Defaults to 15 — or, when you send more than 15 distinct ids, to their number, so one page holds every match.

Required range: 1 <= x <= 100

Response

Successful response

A page of attachments, newest first.

items
object[]
required

The attachments of this page, newest first.

next
string | null
required

Cursor for the next page — send it back as next. null on the last page.

Example:

"NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy"