List automations

GET /api/v3/automations

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

Name of the record.

stringYesYes
eqnot_eqcontainsstarts_withinnot_inemptynot_empty

Trigger kind of the automation.

stringNoYes
eqnot_eqinnot_inemptynot_empty

What record type the automation is for.

stringNoYes
eqnot_eqinnot_inemptynot_empty

The field that will cause the automation to trigger for field_changed automations.

stringNoYes
eqnot_eqinnot_inemptynot_empty

Custom field definition ID associated with the automation if trigger_field is custom_field.

CustomFieldDefinitionNoNoNone

Custom table ID associated with the automation if trigger_record_type is custom_table.

CustomObjectDefinitionNoNoNone

Values that will be used to compare against the trigger field to determine if the automation should trigger.

arrayNoNoNone

The operation to use to determine if the automation should trigger.

stringNoNoNone

Additional field information when using the record_links trigger_field.

stringNoNoNone

The worksheet row of a worksheet custom field if applicable.

stringNoNoNone

Whether the automation is enabled.

booleanNoYes
eq

Run count of the automation.

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

Workspace on which the automation runs.

AutomationTargetNoNo
emptynot_empty

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.

CollectionNoNoNone

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.

CollectionNoNo
emptynot_empty

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