getFavoritesFolder
FolderContentWrapper getFavoritesFolder(metadataTemplateId, metadataFilters, userIdOrGroupId, filterType, count, startIndex, sortBy, sortOrder, filterValue)
GET /api/2.0/files/@favorites
Get the Favorites section
Returns the caller's own Favorites section: the files and folders this account has marked as favorite, together with the section folder itself. Favorites are per-account, so the entries another member marked are not listed here, and a guest sees only their own, usually empty, list. Mark a single file with GET api/2.0/files/favorites/{fileId}, or add and remove batches of files and folders with POST api/2.0/files/favorites and DELETE api/2.0/files/favorites. Nothing in the section is modified, though passing sortBy saves the requested order as the default order for this account. Entries the caller can no longer read, and entries that have been moved to the Trash section, drop out of the listing even though their favorite mark stays, so the section can shrink without an explicit unmark. folders and files hold one page of the section, total counts the entries matching the request before count and startIndex are applied, and current describes the section folder itself.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| metadataTemplateId | query | Integer (int32) | The ID of the metadata template the favorite entries must be assigned to. On its own it narrows the listing to the entries carrying the template; together with the metadata filters it also pins the template the filtered fields belong to. The third-party entries never carry metadata and are left out when the filter is set. | [optional] [example: 1] |
| metadataFilters | query | String | The URL-encoded JSON array of the metadata filter conditions, e.g. [{fieldId:1,op:eq,value:ACME},{fieldId:2,op:range,from:2026-01-01,to:2026-06-30},{fieldId:3,op:in,optionIds:[...]}]. The range bounds are inclusive; a date-only bound covers the whole day. A custom field is addressed by its name instead of the fieldId: {name:Client,op:eq,value:ACME}. | [optional] [example: [{"fieldId":1,"op":"eq","value":"ACME"}]] |
| userIdOrGroupId | query | UUID (uuid) | Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read. | [optional] [example: 00000000-0000-0000-0000-000000000000] |
| filterType | query | FilterType | Narrows the listing to a single kind of entry, such as documents, images or one type of room. Omit it to list every kind the section holds. | [optional] [example: 1] [enum: 0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 17, 20, 22, 23, 24, 25, 26] |
| count | query | Integer (int32) | The size of one page of section content. Pair it with startIndex to walk the listing, and compare the two with total in the response to see when the last page has been read. | [optional] [example: 25] [min: 1] [max: 100] |
| startIndex | query | Integer (int32) | The number of matching entries to skip before the returned page begins; add count to it to ask for the next page. | [optional] [example: 0] |
| sortBy | query | String | The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: DateAndTime, AZ, Size, Author, Type, New, DateAndTimeCreation, RoomType, Tags, Room, CustomOrder, LastOpened and UsedSpace. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place. | [optional] [example: DateAndTime] |
| sortOrder | query | SortOrder | The direction in which the sortBy field is ordered. It is saved together with sortBy as the default order of the account. | [optional] [example: 1] [enum: 0, 1] |
| filterValue | query | String | The search string the section is filtered by: it is matched as a substring of entry titles and, for files, against the indexed document content as well. Omit it to list the section unfiltered. | [optional] [example: My Document] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The Favorites section with one page of the entries the caller marked as favorite | FolderContentWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | A parameter has the wrong type, the count is outside its allowed range, or the startIndex is negative | - | - |
| 403 | The caller is not allowed to read the Favorites section | - | - |
| 404 | The Favorites section could not be resolved for this account | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: Not defined
- Accept: application/json