Get automation

GET /api/v3/automations/{id}

Request

Response

URL

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

cURL command

curl --request GET 'https://example.aha.io/api/v3/automations/123' \
  --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.

ID of the automation

Response fields

Choose which fields to include in the response. 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.

Search fields

Field	Type	Returned by default
Unique record ID.	integer	Yes
Include id in response
Name of the record.	string	Yes
Include name in response
Trigger kind of the automation.	string	No
Include trigger_kind in response Allowed values: `field_changedrecord_createddelayed_field_changed`
What record type the automation is for.	string	No
Include trigger_record_type in response Allowed values: `featurereleaserelease_phaseepicrequirementideainitiativegoalkey_resulttaskapprovalwork_requestdocument`
The field that will cause the automation to trigger for field_changed automations.	string	No
Include trigger_field in response 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
Include custom_field_definition in response Expand this association to browse its response fields.
Custom table ID associated with the automation if trigger_record_type is custom_table.	CustomObjectDefinition	No
Include custom_table in response Expand this association to browse its response fields.
Values that will be used to compare against the trigger field to determine if the automation should trigger.	array	No
Include values in response
The operation to use to determine if the automation should trigger.	string	No
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
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
Include field_worksheet_row in response
Whether the automation is enabled.	boolean	No
Include enabled in response
Run count of the automation.	integer	No
Include run_count in response
Date and time when the record was created.	date-time	No
Include created_at in response
Date and time when the record was last updated.	date-time	No
Include updated_at in response
Workspace on which the automation runs.	AutomationTarget	No
Include automatable in response Expand this association to browse its response fields.
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
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 Expand this association to browse its response fields.
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
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 Expand this association to browse its response fields.

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

Response field selection

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.

See field selection for details.

Response statuses

Error shape for 401, 403, 404

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

record: a single record. Fields are documented above.

Download the complete OpenAPI specification