API Docs

__METHOD= GET . __PATH= /almaws/v1/partners .

Retrieve Partners

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. Authentication should be done by a user that have the 'API Fulfillment Read' role.

Resource URL

GET /almaws/v1/partners

API Description

URL Parameters

None

Querystring Parameters

ParameterTypeRequiredDescription
limitxs:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.
statusxs:stringOptional.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

CodeMessage
402119General error.
401651Identifier not found.