Interface GetOrganizationsRequest

Hierarchy

  • GetOrganizationsRequest

Properties

from?: string

Optional Id from which to start selection.

include_totals?: boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

page?: number

Page index of the results to return. First page is 0.

per_page?: number

Number of results per page. Defaults to 50.

sort?: string

Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at:1. We currently support sorting by the following fields: name, display_name and created_at.

take?: number

Number of results per page. Defaults to 50.