Skip to main content

List Contact Groups (v1)

Method & Path​

GET /api/v1/workspace/:workspaceId/sms/contact-groups

Description​

Lists all SMS contact groups for the 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​

{
  "groups": [
    {
      "id": "66f2...",
      "workspaceId": "66f0...",
      "name": "VIP",
      "mobiles": ["+970599000000"],
      "createdAt": "2026-01-14T10:00:00.000Z",
      "updatedAt": "2026-01-14T10:00:00.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