Get groups

List groups the api user belongs to

Query Parameters

• offset integer

  Offset from start of dataset. Use with the limit query to iterate through dataset.

• limit integer

  Length of dataset to return. Use with offset query to iterate through results.

Responses

• 200

---

operation successful

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  limit int32

  next string

  offset int32

  previous string

  total_count int32

  total number of objects

• objects object[]

  created date-time

  is_active boolean

  modified date-time

  name string

  public_name string

  resource_uri uri

  slug string

  user string

  xframe_allow boolean

  xframe_allow_pdf_edit boolean

{
  "meta": {
    "limit": 0,
    "next": "string",
    "offset": 0,
    "previous": "string",
    "total_count": 0
  },
  "objects": {
    "created": "2020-05-20T:15:10",
    "is_active": true,
    "modified": "2020-05-20T:15:10",
    "name": "my group",
    "public_name": "global exports",
    "resource_uri": "/api/v1/group/my-group/",
    "slug": "my-group",
    "user": "/api/v1/user/u0u0u0u0-u0u0-u0u0-u0u0-u0u0u0u0u0u0/",
    "xframe_allow": false,
    "xframe_allow_pdf_edit": false
  }
}

Loading...