Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Xata

Xata Organizations API

Operations for creating, retrieving, updating, and deleting organizations

Documentation Provider Profile APIs.io OpenAPI GitHub

Xata Organizations API is one of 12 APIs that Xata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Organizations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 14 operations across 9 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://api.xata.tech.

14 operations 9 paths 10 schemas 3 DELETE6 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.xata.tech
Authentication
OpenID Connect, API Key, OAuth 2.0, API Key
Contact
help@xata.io
Resource Areas
1

Authentication & Security 4

Xata Organizations API declares 4 security schemes for authenticating requests. It supports OpenID Connect (oidc) discovered at https://auth.xata.io/realms/xata/.well-known/openid-configuration. An API key is passed in the header as Authorization (apiKey). It supports OAuth 2.0 (xata) using the implicit flow, exposing 13 scopes. An API key is passed in the header as Connection-String (branchConnectionString).

  • apiKey — API key authentication using Bearer token format: Bearer
  • branchConnectionString — Branch PostgreSQL connection string (postgres://user:pass@{branch}.{region}.xata.tech/db), including the embedded password. The hostname selects the target bra…

Paths & Operations 14

Across 9 paths, the API surfaces 14 operations — 3 DELETE, 6 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Organizations 14

Operations for creating, retrieving, updating, and deleting organizations

GET
/organizations
Get list of organizations
getOrganizationsList → 2004004014045XX
POST
/organizations
Create a new organization
createOrganization body → 2014004014045XX
GET
/organizations/{organizationID}
Get organization details
getOrganization 1 param → 2004004014034045XX
PUT
/organizations/{organizationID}
Update organization details
updateOrganization 1 param body → 2004004014034045XX
DELETE
/organizations/{organizationID}
Delete an organization
deleteOrganization 1 param → 2044004014034045XX
GET
/organizations/{organizationID}/members
List members of an organization
listOrganizationMembers 1 param → 200
DELETE
/organizations/{organizationID}/members/{userID}
Remove a member from an organization
removeOrganizationMember 2 params → 204
GET
/organizations/{organizationID}/invitations
List invitations for an organization
listOrganizationInvitations 8 params → 2004004014034045XX
POST
/organizations/{organizationID}/invitations
Send an invitation to join an organization
createOrganizationInvitation 1 param body → 2014004014034044095XX
GET
/organizations/{organizationID}/invitations/{invitationID}
Get details of a specific invitation
getOrganizationInvitation 2 params → 2004004014034045XX
DELETE
/organizations/{organizationID}/invitations/{invitationID}
Delete an invitation
deleteOrganizationInvitation 2 params → 2044004014034045XX
POST
/organizations/{organizationID}/invitations/{invitationID}/resend
Resend an invitation
resendOrganizationInvitation 2 params → 2044004014034045XX
POST
/organizations/{organizationID}/deletion-request
Request organization deletion
requestOrganizationDeletion 1 param → 2024004014034095XX
GET
/organizations/{organizationID}/membership-limits
Get organization membership limits
getOrganizationMembershipLimits 1 param → 2004014035XX

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are OrganizationInvitation (9 properties), OrganizationStatus (8 properties), Organization (4 properties), OrganizationMembershipLimits (2 properties). Each schema is shown below with its type and property counts.

CreateOrganizationInvitationRequest
object
1 property 1 required
CreateOrganizationRequest
object
Request payload for creating a new organization
1 property 1 required
UserID
string
Unique identifier for a user account
UserWithID
OrganizationMembershipLimits
object
Membership limits for an organization
2 properties 2 required
OrganizationInvitation
object
9 properties 6 required
OrganizationID
string
OrganizationStatus
object
8 properties 5 required
Organization
object
Organization details including ID and name
4 properties 3 required
User
object
User information including email, full name, and profile image
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xata-organizations-api-openapi.yml Raw ↑

Other APIs Xata publishes across the network.

Xata API Keys API
AE Profile APIs.io
Xata Billing API
AE Profile APIs.io
Xata Branches API
AE Profile APIs.io
Xata Gateway API
AE Profile APIs.io
Xata GitHub App API
AE Profile APIs.io
Xata Logs API
AE Profile APIs.io
Xata Marketplace API
AE Profile APIs.io
Xata Metrics API
AE Profile APIs.io
Xata Projects API
AE Profile APIs.io
Xata Projects Webhooks API
AE Profile APIs.io
Xata Webhooks API
AE Profile APIs.io
#Organizations
← Back to X APIs
API Details
ID
xata:xata-organizations-api
Base URL
https://api.xata.tech
Docs
https://xata.io/docs/overview
Provider
Xata
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network