Skip to main content

Function: listMembers()

listMembers(client, props): Promise<{ rows: object[]; rowCount: number; }>

Lists members of an organization or project.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

query​

{ pageOffset?: number; pageSize?: number; sortBy?: "createdAt" | "updatedAt" | "role"; sortDir?: "asc" | "desc"; role?: "ADMIN" | "MEMBER" | "VIEWER"; orgName: string; projectName: string; } | { pageOffset?: number; pageSize?: number; sortBy?: "createdAt" | "updatedAt" | "role"; sortDir?: "asc" | "desc"; role?: "ADMIN" | "MEMBER" | "VIEWER"; orgName: string; } = listMembersQuerySchema

Query parameters (orgName, optional projectName, pagination, sorting, optional role filter)

Returns​

Promise<{ rows: object[]; rowCount: number; }>

Promise resolving to a paginated list of members

Operation Id​

list-members