API reference
V1Documents

Documents List

List all SequenceStack public documents

GET
/api/v1/documents

List all SequenceStack public documents

Query Parameters

page?integer

actual page of documents

per_page?integer

number of documents per page

order?string

order by 'field,order'

filter[query]?string

filter documents by title

filter[daterange_from_to]?string

filter by creation date range

Value in

  • "today"
  • "yesterday"
  • "last_7_days"
  • "last_30_days"
  • "current_month"
  • "last_month"
  • "02/21/2024 19:56 - 02/28/2024 19:56"

Response Body

application/json

curl -X GET "https://example.com/api/v1/documents?page=1&per_page=20&order=id%2Cdesc"
{  "status": "ok",  "data": {    "pagination": {      "total_pages": 0,      "current_page": 0    },    "list": [      {        "title": "Document Title",        "content": "Document Content...",        "visibility": "visibility_public"      }    ]  }}

Update Comment PUT

If the specified comment exists, allows you to change content of the comment

Sequence List GET

List all the example sequences created by the admin through the backoffice, with optional parameters to sort or filter for certain sequences based upon searching the titles or other attributes.