Get list of organizations

GET

organizations

curl --request GET \
  --url https://api.xata.tech/organizations \
  --header 'Authorization: Bearer <token>'

{
  "organizations": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": {
        "status": "enabled",
        "disabled_by_admin": true,
        "billing_status": "ok",
        "last_updated": "2023-11-07T05:31:56Z",
        "admin_reason": "<string>",
        "billing_reason": "<string>"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

organizations

object[]

required

List of organizations the user has access to

Show child attributes

organizations.id

string

required

Unique identifier for the organization

organizations.name

string

required

Human-readable name of the organization

organizations.status

object

required

Current status of the organization

Show child attributes

organizations.status.status

enum<string>

required

Indicates whether the organization is active, it's computed as !disabled_by_admin AND billing_status == 'ok'

Available options:

enabled,

disabled

organizations.status.disabled_by_admin

boolean

required

Indicates if the organization has been disabled by an admin

organizations.status.billing_status

enum<string>

required

Indicates the status of the organization from a billing perspective

Available options:

ok,

no_payment_method,

invoice_overdue,

unknown

organizations.status.last_updated

string<date-time>

required

Timestamp of the last update to the organization's status

organizations.status.admin_reason

string

Reason for the current admin status

organizations.status.billing_reason

string

Reason for the current billing status

Create a new organizationCreates a new organization with the authenticated user as its single owner.

⌘I

Get list of organizations

curl --request GET \
  --url https://api.xata.tech/organizations \
  --header 'Authorization: Bearer <token>'

{
  "organizations": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": {
        "status": "enabled",
        "disabled_by_admin": true,
        "billing_status": "ok",
        "last_updated": "2023-11-07T05:31:56Z",
        "admin_reason": "<string>",
        "billing_reason": "<string>"
      }
    }
  ]
}

API Reference

Authorizations

Response