v1
latestOpenAPI 3.0.02026-08-04350108.2 KBList documents
Retrieves documents for the current tenant.
This endpoint supports filtering and pagination through query parameters. Available ransackable attributes: uuid, name, view_uuid, name, creator_uuid, layout_uuid, playbook_uuid, status, content_type, created_at, updated_at.
Query parameters
Page number for pagination (default: 1)
Number of records per page (default: 20, max: 100)
Alias for per_page - number of records per page
Maximum number of records per page (overrides limit if not set)
Set to 'true' to include total count in pagy metadata (data.pagy.count). Use for count/total queries instead of paginating through all pages.
Filter to show only explicitly shared documents
Fuzzy full-text search over document title/content/creator/labels (Elasticsearch). Results are ordered by relevance unless an explicit sort (q[s]) is provided, in which case that sort takes precedence.
Ransack query parameters for filtering. In query strings, use bracket notation: q[name_cont]=john&q[status_eq]=active&q[s]=name+asc. Keys are attribute names with predicates: _cont (contains), _eq (equals), _in (array membership), _gteq (>=), _lteq (<=), _present (not null), _null (is null). The "s" key sorts results (e.g., q[s]=created_at+desc). Example query string: ?q[name_cont]=john&q[s]=name+asc filters names containing "john" sorted by name ascending.