| Field | Type | Required | Description |
|---|---|---|---|
status |
Optional<ListInvitationsQueryParamStatus> | ➖ | Filter invitations based on their status |
query |
Optional<String> | ➖ | Filter invitations based on their email_address or id |
orderBy |
Optional<String> | ➖ | Allows to return invitations in a particular order. At the moment, you can order the returned invitations either by their created_at, email_address or expires_at.In order to specify the direction, you can use the +/- symbols prepended in the property to order by.For example, if you want invitations to be returned in descending order according to their created_at property, you can use -created_at.If you don't use + or -, then + is implied.Defaults to -created_at. |
paginated |
Optional<Boolean> | ➖ | Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated. |
limit |
Optional<Long> | ➖ | Applies a limit to the number of results returned. Can be used for paginating the results together with offset. |
offset |
Optional<Long> | ➖ | Skip the first offset results when paginating.Needs to be an integer greater or equal to zero. To be used in conjunction with limit. |