Skip to content

👥 Client Group

Manage client group records and associated staff assignments.

Operations

List client groups

Request

Retrieve all client groups with basic pagination support

This endpoint returns a paginated list of all client groups in the tenant, including assigned partner/manager staff and office information.

Key Features:

  • Basic pagination with configurable page sizes (default: 50 records)
  • Default sorting by client group name (ascending) then creation date (descending)
  • Total count aggregation for pagination metadata

Real Example:

curl --location 'https://{{host}}/v1/client_groups' \
--data '{
  "pageSize": 25,
  "page": 0
}'
Security
BearerAuth
Bodyapplication/json
pageSizeinteger, [ 1 .. 1000 ]

Maximum number of client group records to return

Default:50
Example:25
pageinteger, >= 0

Number of records to skip for pagination navigation

Default:0
Example:0
curl -i -X POST \
  https://api.doc.aiwyn.ai/_mock/bundle/gql/v1/client_groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pageSize": 25,
    "page": 0
  }'

Responses

Successfully retrieved client group list

Bodyapplication/json
clientGroupsArray of objects(ClientGroup)
totalobject
Response
{
  "clientGroups": [
    { … },
    { … }
  ],
  "total": {
    "aggregate": { … }
  }
}