List design folders

GET/v1/design/folders

Signed-in sessionLaunch key product.designOperation design_folders_list

An internal tool for the components agents build and the rules they follow.

Query parameters

searchstring
cursorstring
expectedAuthorizationVersionstring
limitnumber

Returns

schemaVersion1Required
itemsobject[]Required
unsortednull | objectRequired
completebooleanRequired
nextCursornull | stringRequired

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.

GET/v1/design/folders

curl "$SPECIFY_API_ORIGIN/v1/design/folders" \
  -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \
  -H "X-Specify-Account-Id: <accountId>" \
  -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>"

Response

{
  "result": {
    "schemaVersion": 1,
    "items": [
      {
        "id": "<id>",
        "name": "<name>",
        "kind": "project",
        "source": "designProject",
        "visibility": "private",
        "updatedAt": 1,
        "version": "<version>",
        "counts": {
          "component": 1,
          "block": 1,
          "screenshot": 1,
          "link": 1,
          "note": 1,
          "total": 1,
          "complete": true
        },
        "cover": [
          {
            "id": "<id>",
            "folderId": "<folderId>",
            "kind": "block",
            "title": "<title>",
            "body": "<body>",
            "url": "<url>",
            "visibility": "private",
            "createdAt": 1,
            "updatedAt": 1,
            "version": "<version>",
            "author": {
              "name": "<name>",
              "agent": true
            },
            "component": "<component>",
            "image": "<image>"
          }
        ]
      }
    ],
    "unsorted": "<unsorted>",
    "complete": true,
    "nextCursor": "<nextCursor>"
  }
}

List design folders

Headers

Query parameters

Returns

Errors