List design folder items

GET/v1/design/folders/{id}/items

Signed-in sessionLaunch key product.designOperation design_folder_items_list

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

Path parameters

idstringRequired

Query parameters

searchstring
sort"name" | "updated"
kind"block" | "component" | "inspiration" | "note"
cursorstring
expectedAuthorizationVersionstring
limitnumber

Returns

schemaVersion1Required
folderIdstringRequired
countsobjectRequired
itemsobject[]Required
nextCursornull | stringRequired

Errors

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

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

{ "result": { "schemaVersion": 1, "folderId": "<folderId>", "counts": { "component": 1, "block": 1, "screenshot": 1, "link": 1, "note": 1, "total": 1, "complete": true }, "items": [ { "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>" } ], "nextCursor": "<nextCursor>" } }

List design folder items

Headers

Path parameters

Query parameters

Returns

Errors