Back to Node Auth0

Interface ListOrganizationInvitationsRequestParameters

docs/interfaces/management.Management.ListOrganizationInvitationsRequestParameters.html

5.9.12.0 KB
Original Source

Interface ListOrganizationInvitationsRequestParameters

Example

{ * page: 1, * per_page: 1, * include_totals: true, * fields: "fields", * include_fields: true, * sort: "sort" * }Copy

interface ListOrganizationInvitationsRequestParameters {
page?: number | null;
per_page?: number | null;
include_totals?: boolean | null;
fields?: string | null;
include_fields?: boolean | null;
sort?: string | null;
}

Index

Properties

page?per_page?include_totals?fields?include_fields?sort?

Properties

Optionalpage

page?: number | null

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

Optionalper_page

per_page?: number | null

Number of results per page. Defaults to 50.

Optionalinclude_totals

include_totals?: boolean | null

When true, return results inside an object that also contains the start and limit. When false (default), a direct array of results is returned. We do not yet support returning the total invitations count.

Optionalfields

fields?: string | null

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

Optionalinclude_fields

include_fields?: boolean | null

Whether specified fields are to be included (true) or excluded (false). Defaults to true.

Optionalsort

sort?: string | null

Field to sort by. Use field:order where order is 1 for ascending and -1 for descending Defaults to created_at:-1.

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Properties pageper_pageinclude_totalsfieldsinclude_fieldssort