Organizations API
Manage organizations and their settings
The Organizations API allows you to manage your Xata organizations, including listing, creating, updating, and deleting organizations.
List organizations
Retrieves a list of all organizations you have access to.
GET /organizationsResponse
{
"organizations": [
{
"id": "org_123",
"name": "My Organization",
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
}
]
}Get organization
Retrieves detailed information about a specific organization.
GET /organizations/{organizationID}Path parameters
| Parameter | Type | Description |
|---|---|---|
| organizationID | string | Unique identifier for the organization |
Response
{
"id": "org_123",
"name": "My Organization",
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
}Update organization
Updates the name of an organization.
PATCH /organizations/{organizationID}Path parameters
| Parameter | Type | Description |
|---|---|---|
| organizationID | string | Unique identifier for the organization |
Request body
{
"name": "New Organization Name"
}Response
{
"id": "org_123",
"name": "New Organization Name",
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
}Delete organization
Permanently deletes an organization and all its associated data. This action cannot be undone.
DELETE /organizations/{organizationID}Path parameters
| Parameter | Type | Description |
|---|---|---|
| organizationID | string | Unique identifier for the organization |
Response
Returns a 204 status code with no content on success.
Get available regions
Retrieves a list of all regions where new branches can be deployed for the specified organization.
GET /organizations/{organizationID}/regionsPath parameters
| Parameter | Type | Description |
|---|---|---|
| organizationID | string | Unique identifier for the organization |
Response
{
"regions": [
{
"id": "us-east-1",
"publicAccess": true
},
{
"id": "eu-west-1",
"publicAccess": false
}
]
}Response fields
| Field | Type | Description |
|---|---|---|
| regions | array | Array of available regions with their properties |
| id | string | Unique identifier for the region |
| publicAccess | boolean | Whether data plane is public-facing to the internet in this region |