List documents

GET /api/v3/documents

Request conventions

API key or OAuth2 access token. See Authentication.

Use your account domain and token in copied requests. Request values and conditional fields must satisfy your account’s validation rules.

URL settings

The part before .aha.io. Leave blank to use the example domain.

Number of records per page (default 25, max 200)

Opaque cursor from a previous response to fetch the next page

Fields

Choose fields to return, filter, or sort. Expand a field for examples and associated fields. Collections can only be returned on the top-level resource, not inside an associated resource.

Default response fields are returned until you select specific fields.

Add and edit filters and sorting in field details. Examples illustrate the response shape, not matching records.

FieldTypeReturned by defaultSortableSupported filters

Unique record ID.

integerYesYes
eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty

URL to view the record in Aha!

stringYesNoNone

API URL for the record.

stringYesNoNone

Name of the record.

stringYesYes
eqnot_eqcontainsstarts_withinnot_inemptynot_empty

Reference number of the record.

stringYesYes
eqnot_eqcontainsstarts_withinnot_inemptynot_empty

Type of the document.

stringNoYes
eqnot_eqinnot_inemptynot_empty

Date of the document. For meeting and meeting whiteboard documents, the date and time of the meeting.

date-timeNoYes
eqgtgteltltebetweenemptynot_empty

Length of the meeting in minutes. Only set for meeting and meeting whiteboard documents.

integerNoNoNone

Location of the meeting, such as a room or a video call URL. Only set for meeting and meeting whiteboard documents.

stringNoNoNone

URL the document links to. Only set for external link documents.

stringNoNoNone

Position of the record relative to its siblings.

integerNoYes
eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty

Date and time when the record was created.

date-timeNoYes
eqgtgteltltebetweenemptynot_empty

Date and time when the record was last updated.

date-timeNoYes
eqgtgteltltebetweenemptynot_empty

Status assigned to the document. Only available when the user has Knowledge Advanced.

Availability depends on account settings.
StatusNoNo
emptynot_empty

Workspace that contains the record.

ProjectNoNo
emptynot_empty

User who created the record.

UserNoNo
emptynot_empty

Folder or document that contains the document.

DocumentNoNo
emptynot_empty

HTML body of the document.

NoteNoNo
emptynot_empty

File attached to the document. Only set for file documents.

DocumentFileNoNoNone

Record the document links to. Only set for internal link documents.

LinkedRecordNoNoNone

Users attending the meeting. Empty for documents other than meetings and meeting whiteboards. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=attendees[default]). Capped at 25 records. Only available on the top-level resource.

CollectionNoNo
emptynot_empty

Internal comments on the record. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=comments[default]). Capped at 25 records. Only available on the top-level resource.

CollectionNoNo
emptynot_empty

Status intervals for the document. Requires Knowledge Advanced. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=workflow_status_times[default]). Capped at 25 records. Only available on the top-level resource.

Availability depends on account settings.
CollectionNoNoNone

Search matches the start of a field path and includes matching associations’ subfields. Use a dotted path to search within a specific association.

Query syntax

Return selected fields with a comma-separated fields parameter, or add a field to the defaults with fields=default,{field}. Expand an association above for its supported subfields and selection examples.

Filter with filter.{operator}[{field}]=value. Multiple filters combine with AND. Use comma-separated values for in and not_in, two inclusive bounds for between, and true for empty and not_empty.

Sort with sort.asc={field} or sort.desc={field}. Explicit sorting limits results to 1,000 records. Omit sorting to retrieve all results in descending ID order.

Set the page size with per_page. Follow pagination.next_url while pagination.has_more is true.

Filter operators

eq equals; not_eq does not equal; contains contains text; starts_with starts with text (both case-insensitive).

gt greater than; gte greater than or equal; lt less than; lte less than or equal.

in matches any listed value; not_in excludes listed values; between matches an inclusive range; empty and not_empty check for an absent or present value.

See field selection, filtering, and pagination and sorting limits for details.

Response statuses

Error shape for 400, 401, 403

Type: object

error

Type: object

Required properties: status, code, message, request_id.

status

Type: integer

code

Type: string

message

Type: string

request_id

Type: string

Response envelope and pagination

records: array of records. Fields are documented above.

pagination

Type: object

Required properties: has_more.

has_more

Type: boolean

next_cursor

Type: string or null

next_url

Type: string or null (uri)

truncated

Type: boolean

truncated_message

Type: string

Download the complete OpenAPI specification

© 2026 Aha! Labs Inc. • All rights reserved