Sign in

v1

latestOpenAPI 3.1.02026-07-23310383.1 KB
Components

Retrieves multiple components.

get/api/v1/components

Query parameters

string[]
OR
string uuid

A UUID v4 string that identifies an entity.

pageNumbernumber

The page number.

The page number.

pageSizenumber

The page size.

The page size.

searchstring

Search term to filter components by key.

Search term to filter components by key.

string[]
OR
string uuid

A UUID v4 string that identifies an entity.

Headers

authorizationstring required

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Response

Retrieves all components for the workspace.

createdAtstring date-time required
idstring uuid required

A UUID v4 string that identifies an entity.

isRemovedboolean required
referenceIdstring uuid nullable required

The ID of the original entity in production.

updatedAtstring date-time required
versionIdstring uuid required

A UUID v4 string that identifies an entity.

keystring required

The unique key identifier for this component within the workspace.

workspaceIdstring uuid required

The workspace that owns this component.