List user groups

GET

organizations

groups

Error

A valid request URL is required to generate request examples

{
  "data": {
    "groups": [
      {
        "groupName": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "orgAccess": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "meta": {
    "current_page": 123,
    "items_per_page": 123,
    "total_items": 123,
    "total_pages": 123
  },
  "ok": 1
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

ORG-ID

string

header

required

Query Parameters

page

integer

Required range: x >= 1

limit

integer

Required range: x >= 1

name

string

Substring filter on group name (alias group_name)

group_name

string

group_id

string<uuid>

Exact group UUID filter

Response

Groups loaded

data

object

required

Show child attributes

meta

object

required

Pagination metadata for list endpoints (snake_case keys).

Show child attributes

enum<integer>

required

Available options:

1

Create user group

Error

A valid request URL is required to generate request examples

{
  "data": {
    "groups": [
      {
        "groupName": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "orgAccess": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "meta": {
    "current_page": 123,
    "items_per_page": 123,
    "total_items": 123,
    "total_pages": 123
  },
  "ok": 1
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

Overview

HTTP API

List user groups

Authorizations

Query Parameters

Response