GET /api/v2/automations
Lists all automations for the current account.
Allowed For
- Agents
Available Parameters
You can pass in any combination of the following optional filters:
| Name | Type | Comment |
|---|---|---|
| active | boolean | Only active automations if true, inactive automations if false |
| sort_by | string | Possible values are "alphabetical", "created_at", "updated_at", "usage_1h", "usage_24h", or "usage_7d". Defaults to "position" |
| sort_order | string | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others |
Sideloads
The following sideloads are supported. The usage sideloads are only supported on the Support Professional or Suite Growth plan or above.
| Name | Will sideload |
|---|---|
| app_installation | The app installation that requires each automation, if present |
| permissions | The permissions for each automation |
| usage_1h | The number of tickets processed by an automation in the past hour |
| usage_24h | The number of tickets processed by an automation in the past day |
| usage_7d | The number of tickets processed by an automation in the past week |
| usage_30d | The number of tickets processed by an automation in the past thirty days |
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Returns a maximum of 100 records per page.
Servers
- https://{subdomain}.{domain}.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
No |
Pagination parameter. Supports both traditional offset and cursor-based pagination:
These are mutually exclusive - use one format or the other, not both. |
|
active |
Boolean | No |
Filter by active automations if true or inactive automations if false |
include |
String | No |
A sideload to include in the response. See Sideloads |
per_page |
Integer | No |
Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. |
sort |
String | No |
Field to sort results by. Prefix with When used with cursor pagination, this determines the cursor ordering. Example: |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.