Compositions & Component/Composition Patterns

GET /api/v1/canvas-history (Compositions & Component/Composition Patterns)

GET /api/v1/canvas-history (Compositions & Component/Composition Patterns)

get/api/v1/canvas-history

Request

  • Base URL: https://uniform.app
  • URL: https://uniform.app/api/v1/canvas-history
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Query parameters

compositionIdstring uuid required

Specify the composition ID to get history for

editionIdstring uuid

The edition ID. When set, gets history for a child edition of the compositionId.

projectIdstring uuid required

The project the composition(s) are on

cursorstring

If a request returns a cursor, pass it in this query parameter to get the next page of results

releaseIdstring uuid

The release ID to get history for. Note that release history is independent of base histories

Response

OK

cursorstring

If there are more results, this will be populated with a token to pass in the next request to get the next page of results. If this is undefined then no more results are available

truncatedboolean

If more history is available than your plan allows, and additional entries are available by upgrading, this will be true

Changes

No recorded changes to this operation across all 1 revision of this API.