Skip to main content

​
Overview

This endpoint let users retrieve all available versions of a specific block because there can be multiple versions of same block. Authentication is required through a bearer token.

  • Method: GET
  • URL: /v0/blocks/{name}
  • Operation: Retrieve all versions of a specific block
  • 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>

​
Path Parameters

The only path parameter required here is name which is the name of block.

NameTypeRequiredDescription
namestringYesUnique identifier of the block

​
Response

A 200 OK response indicates that the request to get block versions 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 version of the specificed block.

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",
                "description": "string",
                "id": "string",
                "version_id": "string",
                "name": "string",
                "title": "string",
                "version": "string",
                "status": "int",
                "inputs": [
                    {

                    }
                ],
                "outputs": [
                    {

                    }
                ],
                "catalog_content_url": "url",
                "supported_collections_id": [
                    "string",
                    "string"
                ]
            },
            "created_at": "Date&Time in UTC",
            "err": ""
        }
    ]
}
A 400 error occurs if the request is malformed or includes invalid path parameter. 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 mandatory path parameter. Set the Authorization header with your valid bearer token.
  2. Send the Request:
    Send the request to: https://api.pixxel.space/v0/blocks/{name}
  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.