API reference
V1Folders

Folder List

Return a list of all the folders the the user has created, as well as some summarized information about each folder, including number of sequences inside them.

GET
/api/v1/folders

Return a list of all the folders the the user has created, as well as some summarized information about each folder, including number of sequences inside them.

Authorization

access_token
Authorization<token>

In: header

Query Parameters

page?integer

actual page of folders

per_page?integer

number of folders per page

order?string

order by 'field,order'

workspace_id*string

filter folders by workspace(required)

filter[focus_area_id]?string

filter folders by focus area

filter[except_folder_ids]?string

get all folders except the specified folders(separeted by coma)

filter[except_folder_children]?boolean

get all folders except the specified folder and its children (you need to specify a [except_folder_id] to use this filter.)

filter[folder_id]?string

list only sub-folders inside the specified folder

filter[query]?string

filter folders by title

filter[discarded]?boolean

filter by discarded status

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/folders?page=1&per_page=20&order=id%2Cdesc&workspace_id=string&filter%5Bexcept_folder_ids%5D=k3j7l2rvmp%2Cetb0nwjwbi"
{  "status": "ok",  "data": {    "pagination": {      "total_pages": 0,      "current_page": 0    },    "list": [      {        "id": "string",        "title": "string",        "total_sequences": 0,        "total_folders": 0,        "owner_id": "string",        "owner_team_id": "string",        "created_at": "string",        "updated_at": "string"      }    ]  }}

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.

Create Folder POST

Creates a folder, which allows for the organization of sequences, and stores some information on the created folder, such as how many sequences are contained within it