List design components

GET/v1/design/components

Signed-in sessionLaunch key product.designOperation design_components_list

An internal tool for design rules and components that agents synthesize, review and promote, with evaluation runs to check them.

Query parameters

status"active" | "archived"
searchstring
visibility"private" | "tenant"
projectIdstring
cursorstring
expectedAuthorizationVersionstring
familyKeystring
limitnumber

Returns

schemaVersion1Required
itemsobject[]Required
nextCursornull | stringRequired

Errors

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

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

{ "result": { "schemaVersion": 1, "items": [ { "status": "active", "version": 1, "createdAt": 1, "updatedAt": 1, "id": "<id>", "projectId": "<projectId>", "projectStatus": "active", "key": "<key>", "name": "<name>", "visibility": "private", "familyKey": "<familyKey>", "brief": "<brief>", "repoRef": { "ref": "<ref>", "repository": "<repository>" } } ], "nextCursor": "<nextCursor>" } }

List design components

Headers

Query parameters

Returns

Errors