Return a [paginated](http://developer.apiture.com/docs/concepts/pagination) [sortable](http://developer.apiture.com/docs/concepts/sorting) [filterable](http://developer.apiture.com/docs/concepts/filtering) [searchable](http://developer.apiture.com/docs/concepts/searching) collection of invitations. The [links](http://developer.apiture.com/docs/concepts/links) in the response include pagination links.
curl -X GET -H "API-Key: [[apiKey]]" "http:///invitations/invitations?start=&limit=&sortBy=&filter=&q=&pendingInvitations=&accountUri=&organizationUri=&state=&type=&emailAddress="
import { InvitationApi } from "@apiture/invitations-client-sdk";
const invitationApi = new InvitationApi(configuration);
// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
invitationApi.setAccessToken(accessToken)
// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
invitationApi.setApiKey(apiKey);
var api = new Invitations.InvitationApi.getInvitations()
var opts = {
'start': 789, // {Long} The zero-based index of the first invitation item to include in this page. The default 0 denotes the beginning of the collection.
'limit': 56, // {Integer} The maximum number of invitation representations to return in this page.
'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](http://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
'filter': filter_example, // {String} Optional filter criteria. See [filtering](http://developer.apiture.com/docs/concepts/filtering).
'q': q_example, // {String} Optional search string. See [searching](http://developer.apiture.com/docs/concepts/searching).
'pendingInvitations': true, // {Boolean} Subset the invitations collection to those pending invitations for the currently authenticated user. These are invitations that have been verified by the authenticated user but still require some user action to complete the invitation process. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'accountUri': accountUri_example, // {String} Subset the invitations collection to those with this `accountUri` value. Use `|` to separate multiple values. For example, `?accountUri=https://api.apiture.com/accounts/accounts/0399abed-fd3d-4830-a88b-30f38b8a365c` matches only items whose `accountUri` is `https://api.apiture.com/accounts/accounts/0399abed-fd3d-4830-a88b-30f38b8a365c`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'organizationUri': organizationUri_example, // {String} Subset the invitations collection to those with this `organizationUri` value. Use `|` to separate multiple values. For example,` ?organizationUri=https://api.apiture.com/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c` matches only items whose `organizationUri` is `https://api.apiture.com/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'state': state_example, // {String} Subset the invitations collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=sent` matches only items whose `state` is `sent`; `?state=sent|accepted` matches items whose `state` is `sent` or `accepted`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'type': type_example, // {String} Subset the invitations collection to those whose `type` matches this value. Use `|` to separate multiple values. For example, `?type=joint` matches only items whose `type` is `joint`; `?state=joint|authorizedSigner` matches items whose `type` is `joint` or `authorizedSigner`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'emailAddress': emailAddress_example // {String} Subset the invitations collection to those with this `emailAddress` value. Use `|` to separate multiple values. For example, `?emailAddress=johnsmith@email.com` matches only items whose `emailAddress` is `johnsmith@email.com`; `?emailAddress=johnsmith@email.com|tomjones@email.com` will match items whose `emailAddress` is `johnsmith@email.com` or `tomjones@email.com`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
invitationApi.getInvitations(opts, callback);
Name |
Description |
start |
Long
(int64)
The zero-based index of the first invitation item to include in this page. The default 0 denotes the beginning of the collection.
|
limit |
Integer
(int32)
The maximum number of invitation representations to return in this page.
|
sortBy |
String
Optional sort criteria. See [sort criteria format](http://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
|
filter |
String
Optional filter criteria. See [filtering](http://developer.apiture.com/docs/concepts/filtering).
|
q |
String
Optional search string. See [searching](http://developer.apiture.com/docs/concepts/searching).
|
pendingInvitations |
Boolean
Subset the invitations collection to those pending invitations for the currently authenticated user. These are invitations that have been verified by the authenticated user but still require some user action to complete the invitation process. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
accountUri |
String
Subset the invitations collection to those with this `accountUri` value. Use `|` to separate multiple values. For example, `?accountUri=https://api.apiture.com/accounts/accounts/0399abed-fd3d-4830-a88b-30f38b8a365c` matches only items whose `accountUri` is `https://api.apiture.com/accounts/accounts/0399abed-fd3d-4830-a88b-30f38b8a365c`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
organizationUri |
String
Subset the invitations collection to those with this `organizationUri` value. Use `|` to separate multiple values. For example,` ?organizationUri=https://api.apiture.com/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c` matches only items whose `organizationUri` is `https://api.apiture.com/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
state |
String
Subset the invitations collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=sent` matches only items whose `state` is `sent`; `?state=sent|accepted` matches items whose `state` is `sent` or `accepted`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
type |
String
Subset the invitations collection to those whose `type` matches this value. Use `|` to separate multiple values. For example, `?type=joint` matches only items whose `type` is `joint`; `?state=joint|authorizedSigner` matches items whose `type` is `joint` or `authorizedSigner`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
emailAddress |
String
Subset the invitations collection to those with this `emailAddress` value. Use `|` to separate multiple values. For example, `?emailAddress=johnsmith@email.com` matches only items whose `emailAddress` is `johnsmith@email.com`; `?emailAddress=johnsmith@email.com|tomjones@email.com` will match items whose `emailAddress` is `johnsmith@email.com` or `tomjones@email.com`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|