Skip to main content
GET
/
api
/
v1
/
groups
List groups
curl --request GET \
  --url https://api.example.com/api/v1/groups
[
  {
    "name": "<string>",
    "id": "<string>",
    "account_id": "<string>",
    "account_code": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "member_count": 0
  }
]

Headers

​
authorization
string | null

Query Parameters

​
skip
integer
default:0
​
limit
integer
default:100

Response

Successful Response

​
name
string
required

Group name

Required string length: 1 - 100
​
id
string
required

Group ID

​
account_id
string
required

Account ID (UUID)

​
account_code
string
required

Human-readable account code in XX#### format (e.g., AB1234)

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null

Group description

Maximum string length: 500
​
member_count
integer
default:0

Number of users in the group