Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of associations. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.
curl -X GET -H "API-Key: [[apiKey]]" "http:///associations/associations?start=&limit=&sortBy=&filter=&q=&name=&type=&label="
import { AssociationApi } from "@apiture/associations-client-sdk";
const associationApi = new AssociationApi(configuration);
// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
associationApi.setAccessToken(accessToken)
// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
associationApi.setApiKey(apiKey);
var api = new Associations.AssociationApi.getAssociations()
var opts = {
'start': 789, // {Long} The zero-based index of the first association item to include in this page. The default 0 denotes the beginning of the collection.
'limit': 56, // {Integer} The maximum number of association representations to return in this page.
'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
'name': name_example, // {String} Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is Bartell; `?name=Bartell|kirsten` will match items whose name is Bartell or kirsten. 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 associations collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is Personal Savings; `?type=Personal%20Savings|Investment%20Account` matches items whose type is Personal Savings or Investment Account. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'label': label_example // {String} Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=email_verification` matches only items whose label is `email_verification`; `?label=email_verification|account_verification` matches items whose label is `email_verification` or `account_verification`. 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);
}
};
associationApi.getAssociations(opts, callback);
Name |
Description |
start |
Long
(int64)
The zero-based index of the first association item to include in this page. The default 0 denotes the beginning of the collection.
|
limit |
Integer
(int32)
The maximum number of association representations to return in this page.
|
sortBy |
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
|
filter |
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
q |
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
|
name |
String
Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is Bartell; `?name=Bartell|kirsten` will match items whose name is Bartell or kirsten. 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 associations collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is Personal Savings; `?type=Personal%20Savings|Investment%20Account` matches items whose type is Personal Savings or Investment Account. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
label |
String
Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=email_verification` matches only items whose label is `email_verification`; `?label=email_verification|account_verification` matches items whose label is `email_verification` or `account_verification`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|