SIsigmacomputing
Favorites

Get favorite documents for a user

Get the favorite documents for a specific user. This endpoint has the same functionality as the List all favorite documents of a member endpoint.

Usage notes

  • Retrieve the memberId by calling the /v2/members endpoint.
get/v2/favorites/member/{memberId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

memberIdstring required

Unique identifier of the member.

Query parameters

pagestring

Use to specify further pages using the string returned in the nextPage portion of the response.

limitnumber double

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

Response

The response body.

nextPagestring nullable required

Returns a string that can be used as the page parameter in the next request to fetch the next page of results. The last page of results returns null.

totalnumber double

Total number of results. Useful to determine if there is a need to paginate.

hasMoreboolean

[Deprecated] Indicates whether more results are available.

Changes

No recorded changes to this operation across all 1 revision of this API.