Admin Customer Groups
List customer groups
Paginated, filterable, sortable list. Returns the standard { data, meta } admin envelope.
get/customers/groups
Request
- Base URLhttp://localhost:8000/api/admin
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
pageinteger
Page number
per_pageinteger
Items per page (default 10, max 50).
codestring
Filter by code (partial).
namestring
Filter by name (partial).
is_user_definedinteger
Filter by system/user-defined flag (0/1).
sort'id' | 'code' | 'name'
Sort column.
order'asc' | 'desc'
Sort direction.
Response
Paginated customer groups in the { data, meta } envelope.
Changes
No recorded changes to this operation across all 8 revisions of this API.