Get organization properties (platform-keyed document)

GET

organizations

properties

Error

A valid request URL is required to generate request examples

{
  "data": {},
  "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

1-based page index (default 1)

Required range: x >= 1

limit

integer

Page size (default 50, max 100)

Required range: x >= 1

prop

string

Filter by org_prop_type

Response

Properties loaded

data

object

required

Org properties keyed by org_prop_type (e.g. type, email, website_link, email_config, sms_config, project_policy, custom). Shapes mirror the legacy platform org-props envelope; optional filters still scope which rows hydrate keys. When page/limit are used, only keys for property rows on that page are present (rows ordered by prop).

meta

object

required

Pagination metadata for list endpoints (snake_case keys).

Show child attributes

enum<integer>

required

Available options:

1

Patch an organization property

Error

A valid request URL is required to generate request examples

{
  "data": {},
  "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

Get organization properties (platform-keyed document)

Authorizations

Query Parameters

Response