GET /api/v2/automations/search
Pagination
- Offset pagination only
See Using Offset Pagination.
Allowed For
- Agents
Sideloads
The following sideloads are supported. For more information, see Side-loading.
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 times each automation has been used in the past hour |
usage_24h | The number of times each automation has been used in the past day |
usage_7d | The number of times each automation has been used in the past week |
usage_30d | The number of times each automation has been used in the past thirty days |
Servers
- https://{subdomain}.{domain}.com
Query parameters
Name | Type | Required | Description |
---|---|---|---|
query |
String | Yes |
Query string used to find all automations with matching title |
sort_order |
String | No |
One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others |
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 |
sort_by |
String | No |
Possible values are "alphabetical", "created_at", "updated_at", and "position". If unspecified, the automations are sorted by relevance |
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.