Unlocked Leaks Lists

Get unlocked lists background task status

Changed on

Return the status of a background task started by unlocked lists operations.

This endpoint is only for tasks created by:

  • POST /profile/unlocked/lists/bulk-assign (bulk assign/unassign list)

Usage

  • Use the exact task_id returned by one of these endpoints.

Important

  • Do not use this endpoint for unlock tasks created by /search/.../unlock/task. For unlock tasks, poll /tasks/{task_id} instead.
get/profile/unlocked/list-tasks/{task_id}

Request

Path parameters

task_idstring required

Task id returned by an unlocked-lists operation (delete / clear / bulk).

Response

Task status returned.

task_idstring required
runningboolean required
completedboolean required
totalinteger nullable
updatedinteger nullable
version_conflictsinteger nullable

Example response

{
  "completed": true,
  "running": false,
  "task_id": "a1b2c3:UNLOCK",
  "total": 100,
  "updated": 100,
  "version_conflicts": 0
}

Changes