List releases

GET /api/v3/releases

The request and response builder is not available for this endpoint. See the OpenAPI specification for complete parameters and schemas.

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.

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 release.

stringNoYes
eqnot_eqinnot_inemptynot_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

Start date of the record.

dateNoYes
eqgtgteltltebetweenemptynot_empty

End date of the record.

dateNoYes
eqgtgteltltebetweenemptynot_empty

Release date of the release.

dateNoYes
eqgtgteltltebetweenemptynot_empty

Date when the release was released.

dateNoYes
eqgtgteltltebetweenemptynot_empty

Date when development of the release started.

dateNoYes
eqgtgteltltebetweenemptynot_empty

External release date of the release.

dateNoYes
eqgtgteltltebetweenemptynot_empty

Precision of the external release date.

stringNoYes
eqnot_eqinnot_inemptynot_empty

Whether the release is a parking lot.

booleanNoYes
eq

Position of the record relative to its siblings.

integerNoYes
eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty

How progress is calculated for the release.

stringNoNo
eqnot_eqinnot_inemptynot_empty

How start and end dates are calculated for the release.

stringNoNoNone

Progress completed for the record.

numberNoYes
eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty

Status assigned to the record.

StatusNoNo
emptynot_empty

Owner associated with the release.

UserNoNo
emptynot_empty

HTML description of the record.

NoteNoNo
emptynot_empty

Workspace that contains the record.

ProjectNoNo
emptynot_empty

Parent associated with the release.

ReleaseNoNo
emptynot_empty

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

CollectionNoNo
emptynot_empty

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

CollectionNoNo
emptynot_empty

Children associated with the release. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=children[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

Custom field values. Property names are custom field definition keys, and each value is one of the supported formats below, depending on the field type. Omitted unless requested with the fields parameter or submitted in the request. Fields with no stored value are omitted.

objectNoNoBy custom field type

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

CollectionNoNo
emptynot_empty

Status intervals for the record. Use started_at to identify when it entered a status. 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.

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.

© 2026 Aha! Labs Inc. • All rights reserved