curl \
-X GET 'MEILISEARCH_URL/tasks' \
-H 'Authorization: Bearer API_KEY'client.tasks.getTasks()$client->getTasks();client.get_tasks()client.getTasks();client.tasksclient.GetTasks(nil);ResourceResults<Task> taskResult = await client.GetTasksAsync();let tasks: TasksResults = client
.get_tasks()
.await
.unwrap();await client.getTasks();client.getTasks { (result) in
switch result {
case .success(let tasks):
print(tasks)
case .failure(let error):
print(error)
}
}{
"results": [
{
"uid": 144,
"indexUid": "mieli",
"status": "succeeded",
"type": "indexCreation",
"canceledBy": null,
"details": null,
"error": null,
"duration": "PT0.009330S",
"enqueuedAt": "2024-08-08T09:01:13.348471Z",
"startedAt": "2024-08-08T09:01:13.349442Z",
"finishedAt": "2024-08-08T09:01:13.358772Z"
}
],
"total": 1,
"limit": 1,
"from": 144,
"next": null
}{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}List tasks
The /tasks route returns information about asynchronous operations (indexing, document updates, settings changes, and so on).
Tasks are returned in descending order of uid by default, so the most recently created or updated tasks appear first. Results are paginated and can be filtered using query parameters such as indexUids, statuses, types, and date ranges.
curl \
-X GET 'MEILISEARCH_URL/tasks' \
-H 'Authorization: Bearer API_KEY'client.tasks.getTasks()$client->getTasks();client.get_tasks()client.getTasks();client.tasksclient.GetTasks(nil);ResourceResults<Task> taskResult = await client.GetTasksAsync();let tasks: TasksResults = client
.get_tasks()
.await
.unwrap();await client.getTasks();client.getTasks { (result) in
switch result {
case .success(let tasks):
print(tasks)
case .failure(let error):
print(error)
}
}{
"results": [
{
"uid": 144,
"indexUid": "mieli",
"status": "succeeded",
"type": "indexCreation",
"canceledBy": null,
"details": null,
"error": null,
"duration": "PT0.009330S",
"enqueuedAt": "2024-08-08T09:01:13.348471Z",
"startedAt": "2024-08-08T09:01:13.349442Z",
"finishedAt": "2024-08-08T09:01:13.358772Z"
}
],
"total": 1,
"limit": 1,
"from": 144,
"next": null
}{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Authorizations
An API key is a token that you provide when making API calls. Read more about how to secure your project.
Include the API key to the Authorization header, for instance:
-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'
If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:
const client = new MeiliSearch({
host: 'MEILISEARCH_URL',
apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'
});
Query Parameters
Maximum number of batches to return.
x >= 0uid of the first batch returned.
x >= 0If true, returns results in the reverse order, from oldest to most recent.
Permits to filter tasks by their batch uid. By default, when the
batchUids query parameter is not set, all task uids are returned.
It's possible to specify several batch uids by separating them with
the , character.
x >= 0Permits to filter tasks by their uid. By default, when the uids query
parameter is not set, all task uids are returned. It's possible to
specify several uids by separating them with the , character.
x >= 0Permits to filter tasks using the uid of the task that canceled them.
It's possible to specify several task uids by separating them with
the , character.
x >= 0Permits to filter tasks by their related type. By default, when types
query parameter is not set, all task types are returned. It's possible
to specify several types by separating them with the , character.
Permits to filter tasks by their status. By default, when statuses
query parameter is not set, all task statuses are returned. It's
possible to specify several statuses by separating them with the ,
character.
The status of a task.
enqueued, processing, succeeded, failed, canceled Permits to filter tasks by their related index. By default, when
indexUids query parameter is not set, the tasks of all the indexes
are returned. It is possible to specify several indexes by separating
them with the , character.
Permits to filter tasks based on their enqueuedAt time. Matches tasks enqueued after the given date. Supports RFC 3339 date format.
Permits to filter tasks based on their enqueuedAt time. Matches tasks enqueued before the given date. Supports RFC 3339 date format.
Permits to filter tasks based on their startedAt time. Matches tasks started after the given date. Supports RFC 3339 date format.
Permits to filter tasks based on their startedAt time. Matches tasks started before the given date. Supports RFC 3339 date format.
Permits to filter tasks based on their finishedAt time. Matches tasks finished after the given date. Supports RFC 3339 date format.
Permits to filter tasks based on their finishedAt time. Matches tasks finished before the given date. Supports RFC 3339 date format.
Response
The list of tasks is returned.
Response containing a paginated list of tasks
Array of task objects matching the query
Show child attributes
Show child attributes
Total number of tasks matching the query
x >= 0Maximum number of tasks returned
x >= 0The first task uid returned
x >= 0Value to pass as from parameter to get the next page. When null, there are no more tasks to retrieve.
x >= 0Was this page helpful?