Primo API Docs

Retrieve Favorites

This service returns a list of items that a user has saved in his or her favorites list. The response contains list of the record IDs.

To identify the user properties, this request should contain a user JWT in its header (see User JWT Rest API).
The favorites API header should include the following:

Key: Authorization
Value: Bearer < the jwt from the user JWT API>



Basic URL example for hosted customers:
<api-gateway-url>/primo/v1/favorites?apikey=<apikey>

Note: This API is only available to Primo cloud customers since it depends on the User JWT API, which is only available to Primo Cloud customers for security considerations.

Resource URL

GET /primo/v1/favorites

API Description

• WADL documentation: Download
• Swagger (OpenAPI) documentation: Download

URL Parameters

None

Querystring Parameters

None

Body Parameters

None

Output

Possible Error Codes