API Reference
Reference for the REST API
Retrieve the list of all organizations the authenticated user belongs to, including their IDs and names. This endpoint allows users to view all organizations they have access to.
cURL
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>" } } ] }
The access token received from the authorization server in the OAuth 2.0 flow.
OK
List of organizations the user has access to
Show child attributes
Unique identifier for the organization
Human-readable name of the organization
Current status of the organization
Indicates whether the organization is active, it's computed as !disabled_by_admin AND billing_status == 'ok'
!disabled_by_admin AND billing_status == 'ok'
enabled
disabled
Indicates if the organization has been disabled by an admin
Indicates the status of the organization from a billing perspective
ok
no_payment_method
invoice_overdue
unknown
Timestamp of the last update to the organization's status
Reason for the current admin status
Reason for the current billing status
Was this page helpful?