Get favorite documents for a user

GET

/v2/favorites/member/:memberId

GET

/v2/favorites/member/:memberId

$ curl https://api.sigmacomputing.com/v2/favorites/member/memberId \
>      -H "Authorization: Bearer <token>"

200Response Example

1 {
2   "entries": [
3     {
4       "id": "00000000-0000-0000-0000-000000000000",
5       "urlId": "57a96EMo3GVJG73179MV2l",
6       "name": "Examples",
7       "type": "folder",
8       "parentId": "00000000-0000-0000-0000-000000000001",
9       "parentUrlId": "57a96EMo3GVJG73179MV2G",
10       "permission": "edit",
11       "path": "My Documents/Examples",
12       "badge": "Endorsed",
13       "isArchived": false,
14       "createdBy": "<memberId>",
15       "updatedBy": "<memberId>",
16       "createdAt": "2022-11-22T22:33:47.323Z",
17       "updatedAt": "2022-11-22T22:33:47.323Z",
18       "description": "Examples description",
19       "ownerId": "<memberId>"
20     }
21   ],
22   "nextPage": null,
23   "total": 1,
24   "hasMore": false
25 }

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 the favorite documents for a specific user. This endpoint has the same functionality as the [List all favorite documents of a member](https://help.sigmacomputing.com/reference/listfavoriteinodes) endpoint. ### Usage notes - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

memberIdstringRequired

Unique identifier of the member.

Query parameters

pagestringOptional

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

limitdoubleOptional

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.

entrieslist of objects

Array of results returned by the endpoint

nextPagestring or null

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.

totaldoubleOptional

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

hasMorebooleanOptional

[Deprecated] Indicates whether more results are available.