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_id

Workspace ID

pathstring

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

Responses

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;