Interface InvitationsApiInvitationsListRequest

Request parameters for invitationsList operation in InvitationsApi.

Export

InvitationsApiInvitationsListRequest

Hierarchy

  • InvitationsApiInvitationsListRequest

Properties

filter?: string

JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;owner&#39;].

Memberof

InvitationsApiInvitationsList

org?: string

Organization unique slug

Memberof

InvitationsApiInvitationsList

orgId?: number

Organization identifier

Memberof

InvitationsApiInvitationsList

owner?: string

A simple equality filter for the owner field

Memberof

InvitationsApiInvitationsList

page?: number

A page number within the paginated result set.

Memberof

InvitationsApiInvitationsList

pageSize?: number

Number of results to return per page.

Memberof

InvitationsApiInvitationsList

search?: string

A search term. Available search_fields: (&#39;owner&#39;,)

Memberof

InvitationsApiInvitationsList

sort?: string

Which field to use when ordering the results. Available ordering_fields: [&#39;owner&#39;, &#39;created_date&#39;]

Memberof

InvitationsApiInvitationsList

xOrganization?: string

Organization unique slug

Memberof

InvitationsApiInvitationsList

Generated using TypeDoc