RHrhythms
documents

List documents

Changed on

Retrieves documents for the current tenant.

This endpoint supports filtering and pagination through query parameters. Available ransackable attributes: uuid, name, view_uuid, name, name_sort, creator_uuid, layout_uuid, playbook_uuid, status, content_type, created_at, updated_at.

get/documents

Request

  • Base URL
    https://api.rhythms.ai
  • URL
    https://api.rhythms.ai/documents
  • Auth
    none required

Query parameters

pagenumber

Page number for pagination (default: 1)

per_pagenumber

Number of records per page (default: 20, max: 100)

limitnumber

Alias for per_page - number of records per page

limit_maxnumber

Maximum number of records per page (overrides limit if not set)

offsetnumber

Number of records to skip, for offset/limit clients such as BI connectors. An offset past the end of the collection returns an empty records array, which is the end-of-data signal. To follow data.pagy.next instead of stepping the offset yourself, send it as page while keeping the same offset.

countstring

Set to 'true' to include total count in pagy metadata (data.pagy.count). Use for count/total queries instead of paginating through all pages.

explicitly_sharedboolean

Filter to show only explicitly shared documents

searchstring

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.

qobject

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.

Changes