List folders

GET/folders

Authorization

AuthorizationBearer token · headerrequired

Pass your API key as a Bearer token. API keys are scoped to specific operations — configure scopes in your organization's Settings → Developer → API Keys.

Query parameters

typestring

default: "document"

Allowed:documenttemplate

parent_idstring

Parent folder public ID; omit for root folders

flatboolean

When true, return all folders of the type (ignore parent)

default: false

Responses

200

Folders

foldersFolder[]required

Show properties

Array of Folder

idstringrequired

namestringrequired

typestringrequired

Allowed:documenttemplate

parent_idstring | nullrequired

visibilitystringrequired

Allowed:everyonemembersrestricted

pinnedbooleanrequired

created_atstring<date-time>required

updated_atstring<date-time>required

401

Missing or invalid API key

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

typequeryparent_idqueryParent folder public ID; omit for root foldersflatqueryWhen true, return all folders of the type (ignore parent)

Request

curl -X GET "https://api.seal.nyc/api/v1/folders" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.seal.nyc/api/v1/folders", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.seal.nyc/api/v1/folders",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "folders": [
    {
      "id": "string",
      "name": "string",
      "type": "document",
      "parent_id": "string",
      "visibility": "everyone",
      "pinned": true,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "type": "AUTH_ERROR",
  "status": 401,
  "title": "Missing or invalid API key"
}