List organizations visible to the caller

GET

organizations

Error

A valid request URL is required to generate request examples

{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "org_name": "<string>",
      "deleted_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
}

Authorizations

Authorization

string

header

required

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

Query Parameters

page

integer

Required range: x >= 1

limit

integer

Required range: x >= 1

name

string

Organization name search (also accepts q)

string

Alias for name

org_id

string<uuid>

When set, restrict to this organization if visible to the caller

include_deleted

boolean

Response

Organizations 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 an organization

Error

A valid request URL is required to generate request examples

{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "org_name": "<string>",
      "deleted_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
}

Overview

HTTP API

List organizations visible to the caller

Authorizations

Query Parameters

Response