Skip to main content
GET
/
api
/
contacts
/
bulk-job
/
{jobId}
Poll a bulk-delete background job
curl --request GET \
  --url https://your-instance.example.com/api/contacts/bulk-job/{jobId} \
  --header 'Authorization: Bearer <token>'
{
  "jobId": "b09c2c61-2f8f-4f02-9c1b-2f23a3a2f9c1",
  "status": "pending",
  "processed": 1500,
  "total": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
jobId
string
required

Job UUID returned by DELETE /api/contacts/query-bulk-delete.

Response

Job status

Progress snapshot for a background bulk job (currently query-bulk-delete). processed counts records cumulatively across all batches; total is set to the final count when the job completes.

​
jobId
string
required
​
status
enum<string>
required
Available options:
pending,
completed,
failed
​
processed
integer
required
​
total
integer
required
​
error
string

Present only when status is failed.