Invitations

Search Invitations

Method: GET

URL: https://zstatus.io/api/v0/invitations

Params

KeyDescriptionRequired

Example

const invitations = await api.getInvitations({
})

Example Response

{
"edges": [],
"nodes": [],
"pageInfo": {
"hasNextPage": false,
"hasPreviousPage": false
},
"totalCount": 0
}

API Types

export interface CreateInvitationsResponse {
invitation?: APIInvitation;
member?: APIMember;
}
export interface APIInvitationDeleteResponse {
success: boolean;
}
export interface CreateInvitationProps {
pageId: string;
email: string;
role: APIPageMemberRole;
}
export interface UpdateInvitationProps {
id: string;
role: APIPageMemberRole;
}
export interface APIInvitation extends CreateInvitationProps {
id: string;
token: string;
createdAt: string;
updatedAt: string;
}
export interface APIInvitationSearchArgs {
pageId: string;
}