| Field | Type | Required | Description | Example |
|---|---|---|---|---|
Status |
ListInvitationsQueryParamStatus | ➖ | Filter invitations based on their status | |
Query |
string | ➖ | Filter invitations based on their email_address or id |
|
OrderBy |
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. |
pending |
Paginated |
bool | ➖ | Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated. |
|
Limit |
long | ➖ | Applies a limit to the number of results returned. Can be used for paginating the results together with offset. |
20 |
Offset |
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. |
10 |