Get Groups

Retrieves a list of groups, optionally filtered by GroupID.

Get Groups

cURL

curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/groups \
  --header 'Authorization: <api-key>'

200

[
  {
    "RoleGroupID": 123,
    "RoleGroupName": "<string>",
    "UpdatedDT": "2023-11-07T05:31:56Z",
    "ManagedByAdminBit": true
  }
]

Authorizations

Authorization · string · header · required

Enter your API key. It's required to authenticate API requests.

Query Parameters

GroupID · integer<int32>

The unique identifier of the group to filter the results.

Response

200 - application/json

A list of groups matching the specified criteria.

RoleGroupID · integer<int32> | null

The unique identifier of the role group.

RoleGroupName · string | null

The name of the role group.

UpdatedDT · string<date-time> | null

The date and time when the group information was last updated.

ManagedByAdminBit · boolean | null

Indicates whether the group is managed by an administrator.