Skip to content

List a design's revisions

GET
/v1/designs/{id}/revisions
curl --request GET \
--url 'https://api.pixonaut.app/v1/designs/example/revisions?pageSize=50' \
--header 'Authorization: Bearer <token>'

Operation ID: designs.revisions.list

Every document the design has had, newest first: revision 1 is what was committed, and each correction or restore added the next. One page at a time; nextBefore reads the next older page.

id
required
string
pageSize
integer
default: 50 >= 1 <= 200
before

Only revisions older than this one: a page’s nextBefore.

string

Only revisions older than this one: a page’s nextBefore.

One page of the design’s revisions, newest first

Media typeapplication/json
object
nextBefore
required

The before that reads the next older page; null when this page reaches revision 1.

integer | null
revisions
required
Array<object>
object
createdAt
required
number
createdBy
required

The member who wrote it, named as they are now; null when no member did: a commit, a secret key’s correction, or a revision that predates authorship.

object
name
required
string | null
isCurrent
required

Whether this revision is the design’s document now.

boolean
printed
required

Whether any print rendered this revision.

boolean
revision
required
integer

Examples

Exampleexample

Example

{
"nextBefore": null,
"revisions": [
{
"createdAt": 1791766800000,
"createdBy": {
"name": "Alexandra Lind"
},
"isCurrent": true,
"printed": false,
"revision": 2
},
{
"createdAt": 1791763200000,
"createdBy": null,
"isCurrent": false,
"printed": true,
"revision": 1
}
]
}
X-Request-Id
required
string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

Refused: unauthorized

Media typeapplication/json
object
error
required
string

Examples

Exampleunauthorized

unauthorized

{
"error": "unauthorized"
}
X-Request-Id
required
string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

Refused: origin_forbidden, forbidden, feature_disabled, workspace_suspended

Media typeapplication/json
object
error
required
string
feature

The feature the tenant does not have. Always sent with feature_disabled.

string

Examples

feature_disabled

{
"error": "feature_disabled",
"feature": "api"
}
X-Request-Id
required
string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

Refused: not_found

Media typeapplication/json
object
error
required
string

Examples

Examplenot_found

not_found

{
"error": "not_found"
}
X-Request-Id
required
string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

Refused: invalid_query

Media typeapplication/json
object
error
required
string

Examples

Exampleinvalid_query

invalid_query

{
"error": "invalid_query"
}
X-Request-Id
required
string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

Refused: db_error. A request that failed unexpectedly answers as text instead.

object
error
required
string

Examples

Exampledb_error

db_error

{
"error": "db_error"
}
X-Request-Id
required
string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

Questions? Write to [email protected].

Status · Terms of service · Privacy policy · Subprocessors