Xata

Workspace Members

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

This endpoint allows operations concerning the members of a given workspace.

Expected Parameters

NameDescriptionInRequiredSchema
workspace_idWorkspace IDpath✅string

Get the List Members of a Workspace

GET
https://api.xata.io/workspaces/workspace_id/members

Retrieve the list of members of the given workspace

Status CodeDescriptionExample Response/Type Definition
200OK
type GetWorkspaceMembersList = {
    members: WorkspaceMember[];
    invites: WorkspaceInvite[];
};

type WorkspaceMember = {
    userId: UserID;
    fullname: string;
    /*
     * @format email
     */
    email: string;
    role: Role;
};

type WorkspaceInvite = {
    inviteId: InviteID;
    /*
     * @format email
     */
    email: string;
    /*
     * @format date-time
     */
    expires: string;
    role: Role;
};

/**
 * @pattern [a-zA-Z0-9_-~:]+
 */
type UserID = string;

type Role = "owner" | "maintainer";

/**
 * @pattern [a-zA-Z0-9]+
 */
type InviteID = string;
400Bad Request
type GetWorkspaceMembersList = {
    id?: string;
    message: string;
};
401Authentication Error
{
  "message": "invalid API key"
}
403Authentication Error
{
  "message": "invalid API key"
}
404Example response
type GetWorkspaceMembersList = {
    id?: string;
    message: string;
};
5XXUnexpected Error