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 products. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.
curl -X GET -H "API-Key: [[apiKey]]" "http:///products/products?start=&limit=&sortBy=&name=&type=&code=&category=&state=&target=&ifxType=&filter=&q=&openable=&newAccountAvailability=&productType="
import { ProductApi } from "@apiture/banking_products-client-sdk";
const productApi = new ProductApi(configuration);
// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
productApi.setApiKey(apiKey);
var api = new BankingProducts.ProductApi.getProducts()
var opts = {
'start': 789, // {Long} The zero-based index of the first product in this page. The default, 0, represents the first page of the collection.
'limit': 56, // {Integer} The maximum number of product 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`.
'name': name_example, // {String} Subset the products or product types collection to those with this `name` value. 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 products or product types collection to those with this exact `type` value. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'code': code_example, // {String} Subset the products or product types collection to those whose `code` matches this value. Use `|` to separate multiple values. For example, `?type=B2001` matches only items whose `type` is `B2001`, but `?type=B2001|B3002` matches items whose `type` is `B2001` or `B3002`. This is combined with an implicit `and` with `?state` `?filter` if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'category': category_example, // {String} Subset the products or product types collection to those whose `category` matches this value. Use `|` to separate multiple values. For example, `?category=Savings` matches only items whose `category` is `Savings`, but `?category=Savings|Checking` matches items whose `type` is `Savings` or `Checking`. 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 products or product types collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'target': target_example, // {String} Subset the products or product types collection to those whose `target` matches this value (`personal` or `business`). For example, `?target=personal` matches only items whose `target` is `personal`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'ifxType': ifxType_example, // {String} Subset the products collection to those whose `ifxType` matches this value. Use `|` to separate multiple values. For example, `?ifxType=SDA` matches only items whose `ifxType` is `SDA`; `?ifxType=SDA|DDA` matches items whose `ifxType` is `SDA` or `DDA`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'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).
'openable': true, // {Boolean} If true, filter only by products whose `state` is `active` and `newAccountAvailability` is `available`. For example, `?openable=true` is equivalent to `?state=active&newAccountAvailability=available` .
'newAccountAvailability': newAccountAvailability_example, // {String} Subset the result to only those whose `newAccountAvailability` property matches this value.
'productType': productType_example // {String} Subset the result to only products that use the product type identified by this value. The value is the `_id` of a product type instance. (This query parameter is used to implement the *`apiture:products`* link relation on a product type resource.)
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
productApi.getProducts(opts, callback);
Name |
Description |
start |
Long
(int64)
The zero-based index of the first product in this page. The default, 0, represents the first page of the collection.
|
limit |
Integer
(int32)
The maximum number of product 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`.
|
name |
String
Subset the products or product types collection to those with this `name` value. 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 products or product types collection to those with this exact `type` value. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
code |
String
Subset the products or product types collection to those whose `code` matches this value. Use `|` to separate multiple values. For example, `?type=B2001` matches only items whose `type` is `B2001`, but `?type=B2001|B3002` matches items whose `type` is `B2001` or `B3002`. This is combined with an implicit `and` with `?state` `?filter` if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
category |
String
Subset the products or product types collection to those whose `category` matches this value. Use `|` to separate multiple values. For example, `?category=Savings` matches only items whose `category` is `Savings`, but `?category=Savings|Checking` matches items whose `type` is `Savings` or `Checking`. 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 products or product types collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
target |
String
Subset the products or product types collection to those whose `target` matches this value (`personal` or `business`). For example, `?target=personal` matches only items whose `target` is `personal`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
ifxType |
String
Subset the products collection to those whose `ifxType` matches this value. Use `|` to separate multiple values. For example, `?ifxType=SDA` matches only items whose `ifxType` is `SDA`; `?ifxType=SDA|DDA` matches items whose `ifxType` is `SDA` or `DDA`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
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).
|
openable |
Boolean
If true, filter only by products whose `state` is `active` and `newAccountAvailability` is `available`. For example, `?openable=true` is equivalent to `?state=active&newAccountAvailability=available` .
|
newAccountAvailability |
String
Subset the result to only those whose `newAccountAvailability` property matches this value.
|
productType |
String
Subset the result to only products that use the product type identified by this value. The value is the `_id` of a product type instance. (This query parameter is used to implement the *`apiture:products`* link relation on a product type resource.)
|