Skip to navigation
SDK ReferenceUser Group

List user groups

Requires a project API key, or an account-admin bearer token with the X-Zep-Project header. The account must be entitled to attribute-based access control.

Authentication

AuthorizationApi-Key

Type "Api-Key" followed by a space and the project API key.

Query parameters

limitintegerOptional
Page size
cursorstringOptional
Opaque page cursor

Request

Request body
searchstringOptional

Filters results to items matching this free-text search term.

Response

OK
itemslist of objectsOptional
The user groups on this page.
next_cursorstringOptional

The cursor to pass as the next request's cursor to fetch the following page; absent when no further pages remain.

total_sizeintegerOptional
The total number of matching user groups, counted at the time of this response. It does not indicate whether more pages remain.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error