Skip to main content
Returns a Laravel-paginated list of groups.

​
Endpoint

GET /api/v1/{subdomain}/groups
Required ability: groups.read.

​
Headers

HeaderValue
AuthorizationBearer apitk_...
Acceptapplication/json

​
Path parameters

​
subdomain
string
required
Your workspace subdomain.

​
Query parameters

​
page
integer
1-indexed page number. Defaults to 1.
​
per_page
integer
Items per page. Defaults to 15, maximum 100.

​
Example request

curl "https://dash.xobito.com/api/v1/acme/groups" \
  -H "Authorization: Bearer apitk_your_token_here" \
  -H "Accept: application/json"

​
Example response

200 OK
{
  "status": "success",
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 7,
        "tenant_id": 13,
        "name": "VIP Customers",
        "created_at": "2026-04-01T10:00:00.000000Z",
        "updated_at": "2026-04-01T10:00:00.000000Z"
      }
    ],
    "per_page": 15,
    "total": 4,
    "last_page": 1,
    "from": 1,
    "to": 4,
    "path": "https://dash.xobito.com/api/v1/acme/groups"
  }
}
See Data Types → Group.

​
Error responses

StatusWhenBody
401Missing / invalid token{"status":"error","message":"Invalid API token"}
403Missing ability{"status":"error","message":"Token does not have the required ability: groups.read"}
429Rate limit{"message":"Too many requests","retry_after":45}
500Server error{"status":"error","message":"Failed to list groups"}