Skip to main content

​
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.

NameTypeRequiredDescription
namestringNoFilter blocks by their name
versionstringNoFilter 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.

FieldTypeDescription
idstringUnique ID of the block
block_statusstringStatus of the block (e.g., released)
titlestringName of the block
descriptionstringDescription of the block
versionstringVersion of the block
inputobject[]Array of input data objects. See Data Types for structure details.
outputobject[]Array of output data objects. See Data Types for structure details.
pricenumberUnit price of running block
infoobject[]More information about the block
supported_collections_idstringSensors supported by the block
created_atdateDate when the block was released
Here is a sample response:
200
{
    "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.
400 403
{
  "error": {
    "code": "<string>",
    "details": "<any>",
    "message": "<string>"
  }
}

​
How to use the endpoint

  1. Construct your Request:
    Prepare the GET request and add optional query parameters for filtering. Set the Authorization header with your valid bearer token.
  2. Send the Request:
    Send the request to: https://api.pixxel.space/v0/blocks/workflows
  3. 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.