GET /2/tasks
Retrieves a list of tasks.
Servers
- https://data.{region}.algolia.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
Page number of the paginated API response. |
order |
String | No |
Sort order of the response, ascending or descending. Possible values:
Default value: "desc" |
action[] |
Array | No |
Actions for filtering the list of tasks. |
withEmailNotifications |
Boolean | No |
If specified, the response only includes tasks with notifications.email.enabled set to this value. |
sort |
String | No |
Property by which to sort the list of tasks. Possible values:
Default value: "createdAt" |
enabled |
Boolean | No |
Whether to filter the list of tasks by the |
sourceType[] |
Array | No |
Filters the tasks with the specified source type. |
itemsPerPage |
Integer | No |
Number of items per page. Default value: 10 |
destinationID[] |
Array | No |
Destination IDs for filtering the list of tasks. |
sourceID[] |
Array | No |
Source IDs for filtering the list of tasks. |
triggerType[] |
Array | No |
Type of task trigger for filtering the list of tasks. |
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.