Skip to main content
GET
List factory blueprints
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/factories/listBlueprints?factoryTypeId=&includeDeprecated=&cursor=&limit= returns one page of the deployment’s factory blueprint catalog as FactoryBlueprint objects, newest first. Without includeDeprecated=true only ACTIVE blueprints are listed; factoryTypeId limits the page to one factory type; with both factoryTypeId and includeDeprecated=true, DEPRECATED blueprints come first, each status newest first. includeDeprecated must be exactly true or false, and factoryTypeId must not be empty; anything else is 400 bad_request. Paging follows the same rules as List factories: limit defaults to 50, its maximum (a larger value is 400 too_big), and you follow meta.nextCursor while meta.hasMore is true. Deployment-root catalog. Blueprints have no home org unit, so your role grants must hold factories:read at the deployment root. Holding it only below the root, or at a partner organization’s root, is refused with 403 and requiredPermission: "factories:read". Factory configuration, manager prompt text, the creator, a channel’s external link, and repository settings are not returned. Absent optional values are null or an empty list.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

factoryTypeId
string

Only blueprints of this factory type.

Minimum string length: 1
includeDeprecated
enum<string>
default:false

true to include DEPRECATED blueprints; false (the default) lists ACTIVE ones only.

Available options:
true,
false
limit
integer
default:50

Rows to read for this page, 1 to 50; a larger value is 400 too_big.

Required range: 1 <= x <= 50
cursor
string

The opaque meta.nextCursor from the previous page.

Minimum string length: 1

Response

Blueprint page

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.