Back to Node Auth0

Interface ListFormsRequestParameters

docs/interfaces/management.Management.ListFormsRequestParameters.html

5.9.11.7 KB
Original Source

Interface ListFormsRequestParameters

Example

{ * page: 1, * per_page: 1, * include_totals: true, * hydrate: ["flow_count"] * }Copy

interface ListFormsRequestParameters {
page?: number | null;
per_page?: number | null;
include_totals?: boolean | null;
hydrate?:
| Management.FormsRequestParametersHydrateEnum
| (FormsRequestParametersHydrateEnum | null)[]
| null;
}

Index

Properties

page?per_page?include_totals?hydrate?

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

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

Optionalhydrate

hydrate?:
| Management.FormsRequestParametersHydrateEnum
| (FormsRequestParametersHydrateEnum | null)[]
| null

Query parameter to hydrate the response with additional data

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Properties pageper_pageinclude_totalshydrate