List Blocks - Workflows
Overview
This endpoint let users retrieve list of blocks avialable for running workflows. Blocks here mean different analytical models that are available to run via Workflows. It returns metadata about each block, including id, title, version, status, inputs, and outputs. Users can apply optional filters via query parameters to narrow down blocks by status, or version. Authentication is required through a bearer token.
-
Method:
GET -
URL:
/v0/blocks/workflows -
Operation: Retrieve a list of blocks available to the authenticated user
-
Authentication Required: Yes
Authorization
You need the api key which you can get from the API tab in Workspace Settings. The api key is required in almost all the commands
Authorization: <YOUR_API_KEY>Query Parameters
Query parameters allow you to filter and refine the list of blocks returned by the endpoint. For this endpoint, you can use parameters like status, and version to retrieve specific blocks.
| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | Filter blocks by their name |
version | string | No | Filter blocks based on their version |
Response
A 200 OK response indicates that the request to list blockss was successful. The response contains an array of block objects with details such as id, title, status, version, description, inputs, outputs, and more. Each object represents a distinct block or analytical model available for running workflows.
| Field | Type | Description |
|---|---|---|
id | string | Unique ID of the block |
block_status | string | Status of the block (e.g., released) |
title | string | Name of the block |
description | string | Description of the block |
version | string | Version of the block |
input | object[] | Array of input data objects. See Data Types for structure details. |
output | object[] | Array of output data objects. See Data Types for structure details. |
price | number | Unit price of running block |
info | object[] | More information about the block |
supported_collections_id | string | Sensors supported by the block |
created_at | date | Date when the block was released |
Here is a sample response:
{
"blocks": [
{
"id": "<string>",
"block_status": "<string>",
"spec": {
"kind": "<string>",
"type": "<string>",
"tags": [
"<string>"
],
"description": "<string>",
"id": "<string>",
"version_id": "<string>",
"name": "<string>",
"title": "<string>",
"version": "<string>",
"status": 1,
"inputs": [
{
"format": "vector",
"type": "url",
"name": "<string>",
"version": "<string>"
},
{
"format": "date",
"type": "<string>",
"name": "start_date",
"version": "<string>"
},
{
"format": "date",
"type": "<string>",
"name": "end_date",
"version": "<string>"
}
],
"outputs": [
{
"format": "vector",
"type": "url",
"name": "<string>",
"version": "<string>"
},
{
"format": "tabular",
"type": "url",
"name": "<string>",
"version": "<string>"
}
],
"catalog_content_url": "url",
"price": {
"value": "<number>"
},
"info": {
"name": "<string>",
"intro": "<string>",
"input": "<string>",
"output": "<string>",
"downloadable_files": "<string>"
},
"supported_collections_id": [
"<string>"
]
},
"created_at": "2025-10-24 06:27:03.79012 +0000 UTC",
"err": ""
}
]
}A 400 error occurs if the request is malformed or includes invalid query parameters. A 403 error means access is forbidden, usually due to invalid credentials or insufficient permissions. Both responses return structured error messages detailing the issue encountered.
{
"error": {
"code": "<string>",
"details": "<any>",
"message": "<string>"
}
}How to use the endpoint
-
Construct your Request:
Prepare the GET request and add optional query parameters for filtering. Set the Authorization header with your valid bearer token. -
Send the Request:
Send the request to:https://api.pixxel.space/v0/blocks/workflows -
Examine the Response:
On success (200 OK), you'll receive a list of blocks with full metadata. If there's an issue with the request, you’ll receive a structured error response (400 or 403) explaining the problem.