Get organization

{ "id": "<string>", "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "namespace": "<string>", "name": "<string>", "label": "<string>", "country": "<string>", "capabilities": [ "<string>" ], "vendor": "<string>", "billing_profile_id": "<string>", "billing_legacy": true, "security_contact": "jsmith@example.com", "ai_agent_settings": { "can_enable": true, "performance_agent_enabled": true, "log_analyzer_agent_enabled": true }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "_links": { "self": { "href": "<string>" }, "update": { "href": "<string>", "method": "<string>" }, "delete": { "href": "<string>", "method": "<string>" }, "members": { "href": "<string>" }, "create-member": { "href": "<string>", "method": "<string>" }, "address": { "href": "<string>" }, "profile": { "href": "<string>" }, "account": { "href": "<string>" }, "payment-source": { "href": "<string>" }, "orders": { "href": "<string>" }, "vouchers": { "href": "<string>" }, "discounts": { "href": "<string>" }, "apply-voucher": { "href": "<string>", "method": "<string>" }, "subscriptions": { "href": "<string>" }, "create-subscription": { "href": "<string>", "method": "<string>" }, "estimate-subscription": { "href": "<string>" }, "prepayment": { "href": "<string>" }, "billing-profile": { "href": "<string>" }, "mfa-enforcement": { "href": "<string>" }, "sso": { "href": "<string>" } } }

Authorizations

Authorization

string

header

required

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

Path Parameters

organization_id

string

required

The ID of the organization.
Prefix with name= to retrieve the organization by name instead.

Response

string<ulid>

The ID of the organization.

type

enum<string>

The type of the organization.

Available options:

fixed,

flexible

owner_id

string<uuid>

The ID of the owner.

namespace

string

The namespace in which the organization name is unique.

name

string

A unique machine name representing the organization.

label

string

The human-readable label of the organization.

country

string

The organization country (2-letter country code).

Maximum string length: 2

capabilities

string[]

The organization capabilities.

vendor

string

The vendor.

billing_profile_id

string

The Billing Profile ID.

billing_legacy

boolean

Whether the account is billed with the legacy system.

security_contact

string<email>

The security contact email address for the organization.

ai_agent_settings

object

AI agent consent settings for the organization.

Show child attributes

status

enum<string>

The status of the organization.

Available options:

active,

restricted,

suspended,

deleted

created_at

string<date-time>

The date and time when the organization was created.

updated_at

string<date-time>

The date and time when the organization was last updated.

_links

object

Show child attributes

SDK

REST API

OpenAPI Reference

Authorizations

Path Parameters

Response