List the groups on the instance - LightOn Documentation

List the groups on the instance

curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/instance/groups \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://paradigm.lighton.ai/api/v3/instance/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "category": "<string>",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "user_role": "<string>",
      "members_count": 123,
      "company": {
        "id": 123,
        "name": "<string>"
      }
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

{
  "id": null,
  "code": 403,
  "error": "insufficient_permissions",
  "detail": "You do not have permission to perform this action.",
  "doc_url": "https://developers.lighton.ai/errors#insufficient_permissions"
}

{
  "id": null,
  "code": 422,
  "error": "validation_error",
  "detail": "One or more fields failed validation.",
  "doc_url": "https://developers.lighton.ai/errors#validation_error",
  "fields": {
    "<field_name>": [
      {
        "error": "required",
        "detail": "This field is required."
      }
    ]
  }
}

{
  "detail": "System is under maintenance.",
  "error": "service_maintenance",
  "mode": "full_shutdown",
  "reason": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "endpoint_category_names": [
    "<string>"
  ]
}

GET

/

api

/

v3

/

instance

/

groups

List the groups on the instance

curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/instance/groups \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://paradigm.lighton.ai/api/v3/instance/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "category": "<string>",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "user_role": "<string>",
      "members_count": 123,
      "company": {
        "id": 123,
        "name": "<string>"
      }
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

{
  "id": null,
  "code": 403,
  "error": "insufficient_permissions",
  "detail": "You do not have permission to perform this action.",
  "doc_url": "https://developers.lighton.ai/errors#insufficient_permissions"
}

{
  "id": null,
  "code": 422,
  "error": "validation_error",
  "detail": "One or more fields failed validation.",
  "doc_url": "https://developers.lighton.ai/errors#validation_error",
  "fields": {
    "<field_name>": [
      {
        "error": "required",
        "detail": "This field is required."
      }
    ]
  }
}

{
  "detail": "System is under maintenance.",
  "error": "service_maintenance",
  "mode": "full_shutdown",
  "reason": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "endpoint_category_names": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

category

enum<string>

The category of the group, only custom groups can be created from admin, private and company groups are created automatically

company - Company
private - Private
custom - Custom

Available options:

company,

custom,

private

company_id

integer

company_name

string

name

string

ordering

enum<string>

Order the results by name, created_at or updated_at. Prefix the field with - for descending order (e.g. -created_at). Defaults to name; entries sharing a name are ordered newest-first.

Available options:

-created_at,

-name,

-updated_at,

created_at,

name,

updated_at

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

user_id

integer

Response

List of groups with pagination

count

integer

required

Example:

123

results

object[]

required

Show child attributes

next

string<uri> | null

Example:

"http://api.example.org/accounts/?page=4"

previous

string<uri> | null

Example:

"http://api.example.org/accounts/?page=2"