Skip to main content

List Bulk Jobs (v1)

Method & Path​

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

Description​

Returns the most recent bulk SMS jobs for a workspace.

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​

NameTypeRequiredDescription
workspaceIdstringYesWorkspace ID

Response 200 OK​

{
  "jobs": [
    {
      "id": "66f3...",
      "workspaceId": "66f0...",
      "status": "completed",
      "total": 120,
      "sent": 118,
      "failed": 2,
      "createdAt": "2026-01-14T10:00:00.000Z",
      "updatedAt": "2026-01-14T10:05:10.000Z"
    }
  ]
}

Common Errors​

  • 400 Bad Request: Invalid workspace ID
  • 401 Unauthorized: Missing/invalid workspace token
  • 403 Forbidden: Staff missing sms.send
  • 500 Internal Server Error: Unexpected error