Builder Helpers
A small grab-bag of endpoints that exist to support the Blueprint authoring experience — the visual editor used to design workflows. Each endpoint exposes platform metadata the editor needs to render dropdowns, autocomplete fields, and pickers.
You will rarely call these directly outside the editor or a custom UI built on top of the Factory.
Scopes
| Scope | Reach |
|---|---|
assemblies:read | Listing factory mail templates and their filter metadata. |
assemblies:write | The other helpers (smartnames, factory store, UCS allowed scopes). |
The mail-template listing endpoints exposed here are a read-only convenience view of the data managed under Branding › Mail Templates.
Endpoints
List Factory Mail Templates
GET /api/factory/mailtemplates/
Returns a page of mail-template records, scoped to the editor's view.
Required scope: assemblies:read · also accepts API key
Query parameters — standard pagination set; see Conventions › Pagination. Defaults: sort_by=created, sort_order=desc, hydrate=true.
Response 200 — MailTemplateInDbCursorPage
Get Factory Mail Template Filter Metadata
GET /api/factory/mailtemplates/filters
Returns filter/operator/sort options for List Factory Mail Templates.
Required scope: assemblies:read
Response 200 — open metadata object.
Get Smartnames
GET /api/factory/smartnames
Returns the catalogue of smartnames — template variables the editor can interpolate into workflow step inputs (e.g., {{user.email}}, {{ticket.created}}).
Required scope: assemblies:write
Response 200 — list of smartname definitions.
Get Store Object by URL (Factory)
GET /api/factory/store?url=<store_url>
Resolves a store URL to its underlying object, exposed at the factory namespace so the editor can verify references without leaving the workflow editor.
Required scope: assemblies:write
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
url | string | yes | The store URL to resolve. |
Response 200 — FolderReadContents
TIP
There is a near-identical endpoint at GET /api/store/. The factory variant exists because workflow steps frequently inspect store URLs while being authored, and the assemblies:write scope is the relevant capability check for that editor surface.
Get Factory UCS Allowed Scopes
GET /api/factory/ucs-allowed-scopes
Returns the catalogue of scopes that a blueprint's UCS (User Calling Steps) step is permitted to request from the calling user. Used by the editor to populate the scope picker on UCS step configuration panels.
Required scope: assemblies:write
Response 200 — list of scope identifiers.
See also
- Branding › Mail Templates — the authoritative mail-template management endpoints.
- Asset Store › Get Store Object by URL — the general-purpose store URL resolver.
- Scopes — the complete scope catalogue (a superset of what UCS may request).