Components

get

Retrieves multiple components.

Query parameters

idsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

pageNumbernumber · min: 1Optional

The page number.

Default: 1

pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10

searchstring · min: 1Optional

Search term to filter components by key.

versionIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

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

Responses

200

Retrieves all components for the workspace.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

referenceIdstring · uuid · nullableRequired

The ID of the original entity in production.

updatedAtstring · date-timeRequired

versionIdstring · uuidRequired

A UUID v4 string that identifies an entity.

detailany ofRequired

The detail configuration of the component.

or

or

keystring · min: 1 · max: 100Required

The unique key identifier for this component within the workspace.

Pattern: ^[a-zA-Z0-9_]+$

workspaceIdstring · uuidRequired

The workspace that owns this component.

401

Unauthorized.

application/json

get

/api/v1/components

HTTPcURLJavaScriptPython

GET /api/v1/components HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

[
  {
    "createdAt": "2026-06-11T20:17:15.844Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isRemoved": true,
    "referenceId": "123e4567-e89b-12d3-a456-426614174000",
    "updatedAt": "2026-06-11T20:17:15.844Z",
    "versionId": "123e4567-e89b-12d3-a456-426614174000",
    "detail": {
      "type": "boolean",
      "value": true
    },
    "key": "text",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

post

Creates a new component.

Header parameters

authorizationstringRequired

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

Body

application/json

detailany ofRequired

The detail configuration of the component.

or

or

keystring · min: 1 · max: 100Required

The unique key identifier for this component within the workspace.

Pattern: ^[a-zA-Z0-9_]+$

Responses

200

The component was created.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

referenceIdstring · uuid · nullableRequired

The ID of the original entity in production.

updatedAtstring · date-timeRequired

versionIdstring · uuidRequired

A UUID v4 string that identifies an entity.

detailany ofRequired

The detail configuration of the component.

or

or

keystring · min: 1 · max: 100Required

The unique key identifier for this component within the workspace.

Pattern: ^[a-zA-Z0-9_]+$

workspaceIdstring · uuidRequired

The workspace that owns this component.

401

Unauthorized.

application/json

409

Component key already exists.

application/json

post

/api/v1/components

HTTPcURLJavaScriptPython

POST /api/v1/components HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "detail": {
    "type": "boolean",
    "value": true
  },
  "key": "text"
}

{
  "createdAt": "2026-06-11T20:17:15.844Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "referenceId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T20:17:15.844Z",
  "versionId": "123e4567-e89b-12d3-a456-426614174000",
  "detail": {
    "type": "boolean",
    "value": true
  },
  "key": "text",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

get

Retrieves a component.

Path parameters

idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

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

Responses

200

Retrieves a component.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

referenceIdstring · uuid · nullableRequired

The ID of the original entity in production.

updatedAtstring · date-timeRequired

versionIdstring · uuidRequired

A UUID v4 string that identifies an entity.

detailany ofRequired

The detail configuration of the component.

or

or

keystring · min: 1 · max: 100Required

The unique key identifier for this component within the workspace.

Pattern: ^[a-zA-Z0-9_]+$

workspaceIdstring · uuidRequired

The workspace that owns this component.

401

Unauthorized.

application/json

404

Component not found.

application/json

get

/api/v1/components/{id}

HTTPcURLJavaScriptPython

GET /api/v1/components/{id} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "createdAt": "2026-06-11T20:17:15.844Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "referenceId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T20:17:15.844Z",
  "versionId": "123e4567-e89b-12d3-a456-426614174000",
  "detail": {
    "type": "boolean",
    "value": true
  },
  "key": "text",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

delete

Removes a component.

Path parameters

idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

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

Responses

200

The component was removed.

application/json

messagestringRequired

An informative message for a call that has no effective result to be returned.

401

Unauthorized.

application/json

404

Component not found.

application/json

delete

/api/v1/components/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/components/{id} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "message": "text"
}

patch

Updates a component.

Path parameters

idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

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

Body

application/json

detailany ofOptional

The detail configuration of the component.

or

or

Responses

200

The component was updated.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

referenceIdstring · uuid · nullableRequired

The ID of the original entity in production.

updatedAtstring · date-timeRequired

versionIdstring · uuidRequired

A UUID v4 string that identifies an entity.

detailany ofRequired

The detail configuration of the component.

or

or

keystring · min: 1 · max: 100Required

The unique key identifier for this component within the workspace.

Pattern: ^[a-zA-Z0-9_]+$

workspaceIdstring · uuidRequired

The workspace that owns this component.

401

Unauthorized.

application/json

404

Component not found.

application/json

409

Component key already exists.

application/json

patch

/api/v1/components/{id}

HTTPcURLJavaScriptPython

PATCH /api/v1/components/{id} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "detail": {
    "type": "boolean",
    "value": true
  }
}

{
  "createdAt": "2026-06-11T20:17:15.844Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "referenceId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T20:17:15.844Z",
  "versionId": "123e4567-e89b-12d3-a456-426614174000",
  "detail": {
    "type": "boolean",
    "value": true
  },
  "key": "text",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}