Skip to main content

Function: listOrgs()

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

Lists organizations with optional filtering and pagination.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

query​

{ pageOffset?: number; pageSize?: number; sortBy?: "name" | "createdAt" | "updatedAt"; sortDir?: "asc" | "desc"; userName?: string; visibility?: "PRIVATE" | "PUBLIC"; } = listOrgsQuerySchema

Query parameters for filtering, pagination, and sorting

query.pageOffset?​

number = ...

query.pageSize?​

number = ...

query.sortBy?​

"name" | "createdAt" | "updatedAt" = ...

query.sortDir?​

"asc" | "desc" = ...

query.userName?​

string = ...

query.visibility?​

"PRIVATE" | "PUBLIC" = ...

Returns​

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

Promise resolving to a paginated list of organizations

Operation Id​

list-orgs

Example​

const orgs = await listOrgs(client, {
  query: { visibility: 'PUBLIC', pageOffset: 0, pageSize: 20 }
});