Skip to main content
GET
Get organization

Authorizations

Authorization
string
header
required

Bearer token for the authenticated caller.

Path Parameters

id
string
required
Required string length: 3 - 54

Response

Organization

id
string
required
Required string length: 3 - 54
name
string | null
required

Null once the Organization is deleted: delete erases it at once.

Required string length: 1 - 50
Pattern: ^(?=.*\S)[^\p{Cc}\p{Zl}\p{Zp}]+$
Example:

"Code Zero"

state
enum<string>
required

deleted: soft-deleted until purge_at; afterwards the Organization is not found.

Available options:
active,
deleted
created_at
integer
required

Unix timestamp (seconds)

Required range: 0 <= x <= 9007199254740991
updated_at
integer
required

Unix timestamp (seconds)

Required range: 0 <= x <= 9007199254740991
deleted_at
integer | null
required

Unix timestamp (seconds)

Required range: 0 <= x <= 9007199254740991
purge_at
integer | null
required

Unix timestamp (seconds)

Required range: 0 <= x <= 9007199254740991
etag
string
required

Pass as If-Match to delete only this version. OUTPUT_ONLY.

Maximum string length: 64