Get Bulk Job (v1)

Method & Path

GET /api/v1/workspace/:workspaceId/sms/bulk-jobs/:jobId

Description

Returns the status and progress counters for a bulk SMS job.

Authentication

Required: Workspace auth.

Persona Access:

• Workspace Owner: Allowed
• Staff (role-based): Requires sms.send
• Customer(client): Not allowed

Headers

• Authorization: Bearer <workspaceToken>
• X-Staff-Id: <staffId> (optional; required when acting as Staff)

Path Parameters

Name	Type	Required	Description
workspaceId	string	Yes	Workspace ID
jobId	string	Yes	Bulk job ID

Response 200 OK

{
  "job": {
    "id": "66f3...",
    "workspaceId": "66f0...",
    "status": "running",
    "total": 120,
    "sent": 45,
    "failed": 2,
    "createdAt": "2026-01-14T10:00:00.000Z",
    "updatedAt": "2026-01-14T10:01:10.000Z"
  }
}

Common Errors

• 400 Bad Request: Invalid identifiers
• 401 Unauthorized: Missing/invalid workspace token
• 403 Forbidden: Staff missing sms.send
• 404 Not Found: Job not found
• 500 Internal Server Error: Unexpected error