API Docs
Retrieve Partners
Contents
Retrieves a list of Resource Sharing Partners. Number of results can be limited and offset using the query parameters. For example, to receive the first 2 results send offset=0 and limit=2.
Resource URL
GET /almaws/v1/partners
API Description
URL Parameters
None
Querystring Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | xs:int | Optional. Default: 10 | Limits the number of results. Optional. Valid values are 0-100. Default value: 10. |
offset | xs:int | Optional. Default: 0 | Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned. |
status | xs:string | Optional. | Filter results by their status. Optional. Possible values: ACTIVE, INACTIVE. |
Body Parameters
None
Output
This method returns a Partners object. See doc
Possible Error Codes
| Code | Message |
|---|---|
| 402119 | General error. |
| 401651 | Identifier not found. |