List Organizations - Documentation

GET

organizations

List Organizations

curl --request GET \
  --url https://api.example.com/organizations

{
  "results": [
    {
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "$schema": "<string>",
      "description": "<string>"
    }
  ],
  "$schema": "<string>",
  "pagination": {
    "continue": "<string>"
  }
}

Query Parameters

continue

string

Continuation token value (used when retrieving the next page of results).

integer<int64>

Number of records to show per page of results.

Required range: 0 <= x <= 100

filter

string

Record filter.

Response

results

object[] | null

required

Show child attributes

$schema

string<uri>

read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/ListOrganizationsOutputBody.json"

pagination

object

Show child attributes

Create OrganizationCreate a new Organization An Organization is the top-level object that models a Chkk customer. Organizations are uniquely identified by a UUID, prefixed with the string org_, for example org_c42014e7-baf5-4ec6-a502-858f98dca7c8

⌘I

List Organizations

curl --request GET \
  --url https://api.example.com/organizations

{
  "results": [
    {
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "$schema": "<string>",
      "description": "<string>"
    }
  ],
  "$schema": "<string>",
  "pagination": {
    "continue": "<string>"
  }
}

Documentation Index

Query Parameters

Response