Skip to main content
POST
List user groups

Authorizations

X-Bunker-Token
string
header
required

API token for authentication

Body

application/json
mode
enum<string>
required

Mode of user identification

Available options:
login,
token,
email,
phone,
custom
identity
string
required

User identifier corresponding to the mode

request_metadata
object

Additional metadata for the request

Response

User groups retrieved successfully

status
string
Example:

"ok"

total
integer

Total number of matching records

rows
object[]