Interface GetInvitationsRequest

Hierarchy

  • GetInvitationsRequest

Properties

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

Properties

Optional fields

fields?: string

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.

id

id: string

Organization identifier

Optional include_fields

include_fields?: boolean

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

Optional include_totals

include_totals?: boolean

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.

Optional page

page?: number

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

Optional per_page

per_page?: number

Number of results per page. Defaults to 50.

Optional sort

sort?: string

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

Theme

On This Page