API reference
V1Sequences

Sequence List

List all the sequences created by the user, with optional parameters to sort or filter for certain sequences based upon searching the titles or other attributes. Allows for quick searching and location of sequences

GET
/api/v1/sequences

List all the sequences created by the user, with optional parameters to sort or filter for certain sequences based upon searching the titles or other attributes. Allows for quick searching and location of sequences

Authorization

access_token
Authorization<token>

In: header

Query Parameters

page?integer

actual page of sequences

per_page?integer

number of sequences per page

order?string

order by 'field,order'

filter[root]?boolean

filter sequences without folders

filter[query]?string

filter sequences by title

filter[visibility]?string

filter sequences by visibility

Value in

  • "visibility_public"
  • "visibility_private"
filter[embed]?string

filter sequences by embed status

Value in

  • "embed_enabled"
  • "embed_disabled"
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/sequences?page=1&per_page=20&order=id%2Cdesc"
{  "status": "ok",  "data": {    "pagination": {      "total_pages": 0,      "current_page": 0    },    "list": [      {        "title": "string",        "body": null,        "style": null,        "id": "string",        "embed": "embed_disabled",        "shortlink": null,        "thumbnail": null,        "visibility": "visibility_public",        "owner_id": "string",        "team_owner_id": "string",        "created_at": "string",        "updated_at": "string"      }    ]  }}

Get Sequence Version GET

Retrieves a specific Sequence Versions that belongs to a Sequence and returns the old object value.

Create Sequence POST

Creation of sequences that allow the organization of ideas and interaction of objects. Creates the sequence through the body which accepts UML inputs and generates a visual rendering of the sequence. Has options for public visibility and embedding.