Design References API
A design reference is a link a project keeps to one of its designs: a Figma file, a wireframe, a prototype, a screenshot, an API contract, a sequence diagram, an entity diagram or a document.
A design reference is a link a project keeps to one of its designs: a Figma file, a wireframe, a prototype, a screenshot, an API contract, a sequence diagram, an entity diagram or a document. The link is the record and the file stays where the designer keeps it; the reference says what it is, which version it is, what to look at and whether it belongs to the whole project or to one component. Developers and testers read the references before they build or check a screen, and the client signs off against them.
The reads here see the references of the projects the token may see, a client guest's token among them, because the designs are what the client reviews. A reference outside that set is a 404 RESOURCE_NOT_FOUND, never a 403. Every write runs the same action the Designs page runs, under the project permissions, and announces itself as a design_reference.* event.
Endpoints
/v1/design-references/{reference}Get a design referencePATCH/v1/design-references/{reference}Update a design referenceDELETE/v1/design-references/{reference}Delete a design referenceGET/v1/projects/{project}/design-referencesList design referencesPOST/v1/projects/{project}/design-referencesAdd a design referenceRelated
How is this guide?
Last updated on