Skip to main content
An organization owns projects and their billing, and the people who can reach them. Members belong to it, invitations bring them in. Every command below also takes -h, --help.

list

List all organizations
boolean
default:"false"
Output in JSON format
string
The profile to use
Aliases: xata organization ls

describe

Describe an organization
string
Organization ID
boolean
default:"false"
Output in JSON format
string
The profile to use
Aliases: xata organization view, xata organization show

create

Create a new organization
string
required
Organization Name
boolean
default:"false"
Output in JSON format
string
The profile to use

delete

Delete an organization
string
Organization ID
boolean
default:"false"
Output in JSON format
boolean
default:"false"
Do not ask for confirmation, assume yes.
string
The profile to use

get

Get a field from an organization description
string
Organization ID
string
The profile to use
string
Organization name and/or field to get

members

Manage organization members

members list

List all members of an organization
string
Organization ID
boolean
default:"false"
Output in JSON format
string
The profile to use
Aliases: xata organization members ls

members invite

Send an invitation to join an organization
string
Organization ID
string
Email address to invite
boolean
default:"false"
Output in JSON format
string
The profile to use
Aliases: xata organization members add

members remove

Remove a member from an organization
string
Organization ID
string
ID of the user to remove
boolean
default:"false"
Skip confirmation prompt
boolean
default:"false"
Output in JSON format
string
The profile to use
Aliases: xata organization members delete, xata organization members rm

invitations

Manage organization invitations

invitations list

List all invitations for an organization
string
Organization ID
string
Filter by invitation status (pending or expired)
string
Filter by email address
Search invitations by email or name
boolean
default:"false"
Output in JSON format
string
The profile to use
Aliases: xata organization invitations ls

invitations get

Get details of a specific invitation
string
Organization ID
string
ID of the invitation to view
boolean
default:"false"
Output in JSON format
string
The profile to use
Aliases: xata organization invitations show

invitations create

Create and send an invitation to join an organization
string
Organization ID
string
Email address to invite
boolean
default:"false"
Output in JSON format
string
The profile to use
Aliases: xata organization invitations add, xata organization invitations invite

invitations delete

Delete an invitation
string
Organization ID
string
ID of the invitation to delete
boolean
default:"false"
Skip confirmation prompt
boolean
default:"false"
Output in JSON format
string
The profile to use
Aliases: xata organization invitations rm, xata organization invitations remove

invitations resend

Resend an invitation
string
Organization ID
string
ID of the invitation to resend
boolean
default:"false"
Output in JSON format
string
The profile to use