Component Definitions

GET /api/v1/canvas-definitions (Component Definitions)

GET /api/v1/canvas-definitions (Component Definitions)

get/api/v1/canvas-definitions

Request

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

Query parameters

projectIdstring uuid required

The project ID to get component definitions for

componentIdstring

Limit the list to one result by ID (response remains an array)

offsetinteger

Number of records to skip

limitinteger

Maximum number of records to return

includeSystemboolean

Whether to fetch system meta-component definitions (personalize, test, etc.)

categoriesstring[]

Filter by category ID

Response

OK

Changes

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