GET /api/admin/queues/jobs Returns individual job details from a specific processing queue, filtered by status. Use this to inspect failed jobs or monitor active processing.

​
Headers

​
appid
string
required
Your CometChat App ID.
​
apikey
string
required
Your CometChat API Key.

​
Query parameters

​
queue
string
required
Queue name: campaign-orchestrator or campaign-batch.
​
status
string
required
Job status filter: waiting, active, completed, or failed.
​
limit
integer
default:"20"
Maximum number of jobs to return.

​
Example request

curl "https://{appId}.api-{region}.cometchat.io/v3/business-messaging/api/admin/queues/jobs?queue=campaign-batch&status=failed&limit=10" \
  -H "appid: YOUR_APP_ID" \
  -H "apikey: YOUR_API_KEY"

​
Example response

{
  "queue": "campaign-batch",
  "status": "failed",
  "jobs": [
    {
      "id": "job_abc123",
      "campaignId": "666c3d4e5f6a7b8c9d0e1f2a",
      "attemptsMade": 3,
      "failedReason": "Template not found",
      "data": {
        "batchIndex": 0,
        "recipientCount": 500
      },
      "createdAt": "2024-01-15T09:30:00.000Z",
      "processedAt": "2024-01-15T09:31:00.000Z"
    }
  ]
}

​
Response fields

​
queue
string
The queried queue name.
​
status
string
The queried status filter.
​
jobs
object[]
Array of job details.
​
jobs[].id
string
Unique job identifier.
​
jobs[].campaignId
string
The campaign associated with this job.
​
jobs[].attemptsMade
integer
Number of processing attempts.
​
jobs[].failedReason
string
Error message if the job failed.
​
jobs[].data
object
Job-specific data including batch index and recipient count.
​
jobs[].createdAt
string
ISO 8601 timestamp when the job was created.
​
jobs[].processedAt
string
ISO 8601 timestamp when the job was last processed.
Use this endpoint to debug failed campaign deliveries. The failedReason field provides the error message, and data shows which batch and how many recipients were affected.