Favorite Folder
A user-created folder for organizing favorite items in the sidebar
List Favorite Folders
List favoriteFolders. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 2 fields. Ordered by order unless you pass sort.
Required scope: favorite-folders:read
query Parameters
sortField to sort by. Prefix with - for descending (-createdAt); a createdAt:desc / createdAt:asc suffix works too, but never both markers at once. Default: order.
cursorOpaque cursor for the next page (the envelope nextCursor).
limitItems per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow nextCursor instead of assuming one page held everything.
includeTotalWhen true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.
expandComma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.
name[eq]Filter where name equals.
name[contains]Filter where name contains.
name[startsWith]Filter where name starts with.
createdAt[gt]Filter where createdAt is greater than.
createdAt[gte]Filter where createdAt is greater than or equal to.
createdAt[lt]Filter where createdAt is less than.
createdAt[lte]Filter where createdAt is less than or equal to.
List Favorite Folders › Responses
OK
The page of results.
totalTotal rows matching the query (across pages).
limithasMorenextCursorOpaque cursor for the next page; null on the last page.
Create Favorite Folder
Create a Favorite Folder. Server-assigned fields are ignored if sent.
Required scope: favorite-folders:write
query Parameters
expandComma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.
Headers
Idempotency-KeyOptional replay key (see Idempotent requests above).
Create Favorite Folder › Request Body
nameFolder name shown in the sidebar. Capped at 30 characters, which is easy to hit.
orderRank within the sidebar. Omit it and the server appends the folder at the end.
Create Favorite Folder › Responses
Created
idUnique identifier — an opaque string; never parse or generate one.
createdAtCreation timestamp
nameFolder name shown in the sidebar. Capped at 30 characters, which is easy to hit.
orderRank within the sidebar. Omit it and the server appends the folder at the end.
createdByIdTeam member who created this folder. A member id — resolve it with GET /members/{id}.
updatedAtLast update timestamp
updatedByIdTeam member who last updated this folder. A member id — resolve it with GET /members/{id}.
The related Team Member, present only when you pass ?expand=createdBy.
The related Team Member, present only when you pass ?expand=updatedBy.
Get Favorite Folder
Retrieve a single Favorite Folder by id.
Required scope: favorite-folders:read
path Parameters
id^[0-9A-Za-z_!]+$ · requiredId of the Favorite Folder.
query Parameters
expandComma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.
Get Favorite Folder › Responses
OK
idUnique identifier — an opaque string; never parse or generate one.
createdAtCreation timestamp
nameFolder name shown in the sidebar. Capped at 30 characters, which is easy to hit.
orderRank within the sidebar. Omit it and the server appends the folder at the end.
createdByIdTeam member who created this folder. A member id — resolve it with GET /members/{id}.
updatedAtLast update timestamp
updatedByIdTeam member who last updated this folder. A member id — resolve it with GET /members/{id}.
The related Team Member, present only when you pass ?expand=createdBy.
The related Team Member, present only when you pass ?expand=updatedBy.
Delete Favorite Folder
Permanently delete this Favorite Folder. This cannot be undone.
Required scope: favorite-folders:delete
path Parameters
id^[0-9A-Za-z_!]+$ · requiredId of the Favorite Folder.
Headers
Idempotency-KeyOptional replay key (see Idempotent requests above).
Delete Favorite Folder › Responses
No Content
Update Favorite Folder
Partially update a Favorite Folder. Only the fields you send are changed.
Required scope: favorite-folders:write
path Parameters
id^[0-9A-Za-z_!]+$ · requiredId of the Favorite Folder.
query Parameters
expandComma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.
Headers
Idempotency-KeyOptional replay key (see Idempotent requests above).
Update Favorite Folder › Request Body
nameFolder name shown in the sidebar. Capped at 30 characters, which is easy to hit.
orderRank within the sidebar. Omit it and the server appends the folder at the end.
expectedUpdatedAtOptional concurrency guard: the updatedAt you last read. If the resource has changed since, the update is rejected with 409 instead of overwriting the other writer. Re-read, re-derive your change from the current values, and retry with the fresh updatedAt.
Update Favorite Folder › Responses
OK
idUnique identifier — an opaque string; never parse or generate one.
createdAtCreation timestamp
nameFolder name shown in the sidebar. Capped at 30 characters, which is easy to hit.
orderRank within the sidebar. Omit it and the server appends the folder at the end.
createdByIdTeam member who created this folder. A member id — resolve it with GET /members/{id}.
updatedAtLast update timestamp
updatedByIdTeam member who last updated this folder. A member id — resolve it with GET /members/{id}.
The related Team Member, present only when you pass ?expand=createdBy.
The related Team Member, present only when you pass ?expand=updatedBy.
Search Favorite Folders
Full-text ranked search across favoriteFolders. Ranked by relevance; pages are capped at 200 results. Filterable by 2 fields.
Required scope: favorite-folders:read
query Parameters
qFull-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.
cursorOpaque cursor for the next page (the envelope nextCursor).
limitItems per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow nextCursor instead of assuming one page held everything.
includeTotalWhen true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.
expandComma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.
name[eq]Filter where name equals.
name[contains]Filter where name contains.
name[startsWith]Filter where name starts with.
createdAt[gt]Filter where createdAt is greater than.
createdAt[gte]Filter where createdAt is greater than or equal to.
createdAt[lt]Filter where createdAt is less than.
createdAt[lte]Filter where createdAt is less than or equal to.
Search Favorite Folders › Responses
OK
The page of results.
totalTotal rows matching the query (across pages).
limithasMorenextCursorOpaque cursor for the next page; null on the last page.