List automations

GET /api/v3/automations

Request

Response

URL

GET https://example.aha.io/api/v3/automations

cURL command

curl --request GET 'https://example.aha.io/api/v3/automations' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json'

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

Account subdomain

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

per_page

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

after

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.

Search fields

Field	Type	Returned by default	Sortable	Supported filters
Unique record ID.	integer	Yes	Yes	`eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty`
Include id in responseSort by id
Name of the record.	string	Yes	Yes	`eqnot_eqcontainsstarts_withinnot_inemptynot_empty`
Include name in responseSort by name
Trigger kind of the automation.	string	No	Yes	`eqnot_eqinnot_inemptynot_empty`
Include trigger_kind in responseSort by trigger_kind Allowed values: `field_changedrecord_createddelayed_field_changed`
What record type the automation is for.	string	No	Yes	`eqnot_eqinnot_inemptynot_empty`
Include trigger_record_type in responseSort by trigger_record_type Allowed values: `featurereleaserelease_phaseepicrequirementideainitiativegoalkey_resulttaskapprovalwork_requestdocument`
The field that will cause the automation to trigger for field_changed automations.	string	No	Yes	`eqnot_eqinnot_inemptynot_empty`
Include trigger_field in responseSort by trigger_field Allowed values: `namestatusteam_statustypeinitiativeassigned_to_usercreated_by_userepicend_datestart_datetagsgoalskey_resultsscorereleasewatchersteamiterationrecord_riskprogressinitial_estimatedetailed_estimaterecord_linkscustom_fieldownerrelease_datedevelopment_started_onexternal_release_dateinitiativesroll_up_initiativetime_framerollup_goalstarget_metricstarting_metriccurrent_metricduplicate_ideacategoriesvisibilitynum_endorsementsnum_organizationssubmitted_idea_portalparentcollectionstask_statusdue_dateapproval_groupsassignees`
Custom field definition ID associated with the automation if trigger_field is custom_field.	CustomFieldDefinition	No	No	None
Include custom_field_definition in response Association filters apply to this field itself. Expand its subfields below to see their individual capabilities.
Custom table ID associated with the automation if trigger_record_type is custom_table.	CustomObjectDefinition	No	No	None
Include custom_table in response Association filters apply to this field itself. Expand its subfields below to see their individual capabilities.
Values that will be used to compare against the trigger field to determine if the automation should trigger.	array	No	No	None
Include values in response
The operation to use to determine if the automation should trigger.	string	No	No	None
Include change_type in response Allowed values: `specificany=addremove><currentpresentblankpresent_with_commentparking_lotnon_parking_lot`
Additional field information when using the record_links trigger_field.	string	No	No	None
Include link_filter_type in response Allowed values: `link_typelinked_recordlinked_record_status`
The worksheet row of a worksheet custom field if applicable.	string	No	No	None
Include field_worksheet_row in response
Whether the automation is enabled.	boolean	No	Yes	`eq`
Include enabled in responseSort by enabled
Run count of the automation.	integer	No	Yes	`eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty`
Include run_count in responseSort by run_count
Date and time when the record was created.	date-time	No	Yes	`eqgtgteltltebetweenemptynot_empty`
Include created_at in responseSort by created_at
Date and time when the record was last updated.	date-time	No	Yes	`eqgtgteltltebetweenemptynot_empty`
Include updated_at in responseSort by updated_at
Workspace on which the automation runs.	AutomationTarget	No	No	`emptynot_empty`
Include automatable in response Association filters apply to this field itself. Expand its subfields below to see their individual capabilities.
A list of additional conditions that must be met for the automation to trigger. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=trigger_conditions[default]). Capped at 25 records. Only available on the top-level resource.	Collection	No	No	None
Collection envelope Records use the associated fields below. Type: `object` Required properties: records, has_more. url Type: `string` (uri) has_more Type: `boolean` next_url Type: `string` (uri) Include trigger_conditions in response Association filters apply to this field itself. Expand its subfields below to see their individual capabilities.
Logs associated with the automation. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=logs[default]). Capped at 25 records. Only available on the top-level resource.	Collection	No	No	`emptynot_empty`
Collection envelope Records use the associated fields below. Type: `object` Required properties: records, has_more. url Type: `string` (uri) has_more Type: `boolean` next_url Type: `string` (uri) Include logs in response Association filters apply to this field itself. Expand its subfields below to see their individual capabilities.

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