Workspace Invites

https://api.xata.io/workspaces/workspace_id/invites

This endpoint enables working with invites for a given workspace.

Expected parameters

NameDescriptionInRequiredSchema
workspace_id

Workspace ID

pathstring

Invite a User to Join the Workspace

POST
https://api.xata.io/workspaces/workspace_id/invites

Invite some user to join the workspace with the given role

Request Body Type Definition

type InviteWorkspaceMember = {
    /**
     * @format email
     */
    email: string;
    role: Role;
};
 
type Role = "owner" | "maintainer";

Responses

type InviteWorkspaceMember = {
    inviteId: InviteID;
    /**
     * @format email
     */
    email: string;
    /**
     * @format date-time
     */
    expires: string;
    role: Role;
};
 
/**
 * @pattern [a-zA-Z0-9]+
 */
type InviteID = string;
 
type Role = "owner" | "maintainer";