latestOpenAPI 3.0.32026-08-19299284712.8 KB

67d9f45bb99b

Library

Read-only unified listing of Library entries: folders, templates, and files. Each row carries a type discriminator (folder, template, or file) and the fields relevant to that kind. Folders are always pinned to the top of the page regardless of ?ordering=. The listing is shallow -- use ?folder_id= to drill into a folder. file covers both binary uploads and URL bookmarks (same underlying model).

get/library

Query parameters

created_by_idinteger

Filter to entries created by the given user id.

folder_idinteger

Folder id to scope the listing to (drill-in). Omit to list the root context.

limitinteger

Number of results to return per page.

orderingstring

Comma-separated sort tokens (prefix - for descending). Allowed: ['created_at', 'created_by', 'last_opened_at', 'name', 'sharing_scheme']. Default: -created_at. Folders always pin at the top regardless of ordering.

pageinteger

A page number within the paginated result set.

searchstring

Case-insensitive substring match on name, applied at SQL before pagination.

type'all' | 'file' | 'template'

Single value: all (default), template, or file. Narrows the non-folder kinds shown. Folders are always included in the response regardless of this filter -- use ?folder_id= to scope inside a folder instead. file covers both binary uploads and URL bookmarks (they share the underlying TemplateUpload model).

Headers

X-Company-IDstring required

Associates request with company

Response

No response body