List groups (paginated)

GET

/groups

Contract

Parameter	Value
Section	groups
Authentication	CookieAuth
Consumes	not required
Produces	application/json

Parameters

6 parameters

Name	Location	Required	Type	Description
input	query	no	string	Search by group name, email address, or creator name
group_id	query	no	string	Filter by group ID
count	query	yes	integer	Page size
page	query	yes	integer	Page number, starting at 1
key	query	yes	string	Sort field
order	query	yes	enum(asc, desc)	Sort direction

"asc"

Responses

4 responses

Status	Description	Type
200	Successful response	object
400	Invalid query parameters	object
401	Unauthorized	object
500	Internal server error	object

Response 200: object

{
  "cursor": {
    "count": 0,
    "currentPage": 0,
    "totalPages": 0,
    "totalRows": 0
  },
  "data": [
    {
      "createdAt": "<string>",
      "deletedAt": "<string>",
      "id": 0,
      "issuer": {
        "agreementAccepted": true,
        "createdAt": "<string>",
        "deletedAt": "<string>",
        "email": "<string>",
        "group": {},
        "groupID": 0,
        "id": 0,
        "isActive": true,
        "isRequiredToSetPassword": true,
        "lastLogin": "<string>",
        "notificationsReadAt": "<string>",
        "passwordLength": 0,
        "realName": "<string>",
        "updatedAt": "<string>"
      },
      "issuerID": 0,
      "name": "<string>",
      "permissions": [
        {
          "value": 0
        }
      ],
      "updatedAt": "<string>",
      "users": [
        {
          "agreementAccepted": true,
          "createdAt": "<string>",
          "deletedAt": "<string>",
          "email": "<string>",
          "group": {},
          "groupID": 0,
          "id": 0,
          "isActive": true,
          "isRequiredToSetPassword": true,
          "lastLogin": "<string>",
          "notificationsReadAt": "<string>",
          "passwordLength": 0,
          "realName": "<string>",
          "updatedAt": "<string>"
        }
      ]
    }
  ]
}

{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }