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 organizations. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.
curl -X GET -H "API-Key: [[apiKey]]" "http:///organizations/organizations?start=&limit=&sortBy=&filter=&q=&type=&state=&name=&customerId="
import { OrganizationApi } from "@apiture/organizations-client-sdk";
const organizationApi = new OrganizationApi(configuration);
// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
organizationApi.setAccessToken(accessToken)
// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
organizationApi.setApiKey(apiKey);
var api = new Organizations.OrganizationApi.getOrganizations()
var opts = {
'start': 789, // {Long} The zero-based index of the first organization item to include in this page. The default 0 denotes the beginning of the collection.
'limit': 56, // {Integer} The maximum number of organization 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).
'type': type_example, // {String} Subset the organizations collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=corporation` matches only items whose type is `corporation`; `?type=llp|llc` matches items whose type is `llp` or `llc`. 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 organizations 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).
'name': name_example, // {String} Subset the organizations collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose name is Bartell; `?name=Bartell|kirsten` matches 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).
'customerId': customerId_example // {String} Subset the organization collection to those whose `customerId` matches this value. 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);
}
};
organizationApi.getOrganizations(opts, callback);
Name |
Description |
start |
Long
(int64)
The zero-based index of the first organization item to include in this page. The default 0 denotes the beginning of the collection.
|
limit |
Integer
(int32)
The maximum number of organization 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).
|
type |
String
Subset the organizations collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=corporation` matches only items whose type is `corporation`; `?type=llp|llc` matches items whose type is `llp` or `llc`. 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 organizations 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).
|
name |
String
Subset the organizations collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose name is Bartell; `?name=Bartell|kirsten` matches 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).
|
customerId |
String
Subset the organization collection to those whose `customerId` matches this value. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|