Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [filterable](https://developer.apiture.com/docs/concepts/filtering) collection of organizations. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links. The result is limited to partner organizations that the caller has access to (usually, their own partner organization) based on their email address domain. (Admin users have access to all partner organizations.)
curl -X GET -H "API-Key: [[apiKey]]" "http:///partners/organizations?start=&limit=&filter=&domain=&type=&state=&name="
import { PartnerOrganizationApi } from "@apiture/partner_organizations-client-sdk";
const partnerOrganizationApi = new PartnerOrganizationApi(configuration);
// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
partnerOrganizationApi.setAccessToken(accessToken)
// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
partnerOrganizationApi.setApiKey(apiKey);
var api = new PartnerOrganizations.PartnerOrganizationApi.getOrganizations()
var opts = {
'start': start_example, // {String} Represents the first record of the page of results. This is supplied by the service when paginating items: the `next` link includes a `?start=` query parameter which refers to beginning of the next page of items.
'limit': 56, // {Integer} The maximum number of organization representations to return in this page.
'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'domain': domain_example, // {String} Subset the result to match only partner organizations whose `domain` property matches this value. This is combined with the `filter` query, if any, via and implicit `and`. Note that for most users, the collection is already implicitly filtered to their organization.
'type': type_example, // {String} Subset the organizations collection to those with this exact type value. Use | to separate multiple values. For example, `?type=corporation` will match only items whose type is `corporation`; `?type=llp|llc` will match 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': , // {array[String]} Subset the resources to only those whose `state` matches the query, such as `?state=active`. The value may be a `|` separated list of states, such as `?state=pending|active` to match all resources whose `state` is either `pending` _or_ `active`. If `?filter=` is also used, the two are combined with an implicit `and()` operation.
'name': name_example // {String} Subset the organizations 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).
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
partnerOrganizationApi.getOrganizations(opts, callback);
Name |
Description |
start |
String
Represents the first record of the page of results. This is supplied by the service when paginating items: the `next` link includes a `?start=` query parameter which refers to beginning of the next page of items.
|
limit |
Integer
(int32)
The maximum number of organization representations to return in this page.
|
filter |
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
domain |
String
Subset the result to match only partner organizations whose `domain` property matches this value. This is combined with the `filter` query, if any, via and implicit `and`. Note that for most users, the collection is already implicitly filtered to their organization.
|
type |
String
Subset the organizations collection to those with this exact type value. Use | to separate multiple values. For example, `?type=corporation` will match only items whose type is `corporation`; `?type=llp|llc` will match 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 |
array[String]
Subset the resources to only those whose `state` matches the query, such as `?state=active`. The value may be a `|` separated list of states, such as `?state=pending|active` to match all resources whose `state` is either `pending` _or_ `active`. If `?filter=` is also used, the two are combined with an implicit `and()` operation.
|
name |
String
Subset the organizations 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).
|