List configs - Allium Documentation Hub

Get Beams Handler

curl --request GET \
  --url https://api.allium.so/api/v1/beam \
  --header 'X-API-KEY: <api-key>'

[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "owner_org_team_user_id": "<string>",
    "pipeline_config": {
      "source": {
        "type": "pubsub",
        "is_zerolag": false
      },
      "transforms": [
        {
          "script": "<string>",
          "uid": "<string>",
          "type": "v8"
        }
      ],
      "sinks": [
        {
          "name": "<string>",
          "uid": "<string>",
          "type": "kafka"
        }
      ]
    },
    "organization_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "tags": [
      "<string>"
    ],
    "static_egress_ip": false,
    "pod_size": "S"
  }
]

GET

api

beam

Get Beams Handler

curl --request GET \
  --url https://api.allium.so/api/v1/beam \
  --header 'X-API-KEY: <api-key>'

[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "owner_org_team_user_id": "<string>",
    "pipeline_config": {
      "source": {
        "type": "pubsub",
        "is_zerolag": false
      },
      "transforms": [
        {
          "script": "<string>",
          "uid": "<string>",
          "type": "v8"
        }
      ],
      "sinks": [
        {
          "name": "<string>",
          "uid": "<string>",
          "type": "kafka"
        }
      ]
    },
    "organization_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "tags": [
      "<string>"
    ],
    "static_egress_ip": false,
    "pod_size": "S"
  }
]

Returns every Beam pipeline config the authenticated user has read access to (configs they own, configs shared with them as editor/reader, and configs whose viewer_team is a team they belong to).

Required permission: read — owners, editors, readers, and members of teams shared via viewer_team.

Response: BeamConfig[]

curl -X GET https://api.allium.so/api/v1/beam \
  -H "X-API-Key: ${ALLIUM_API_KEY}"

Show Example response

[
  {
    "id": "abc123",
    "name": "USDC Transfer Monitor",
    "description": "Monitors USDC ERC20 transfers on Base",
    "owner_org_team_user_id": "org_xyz",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z",
    "tags": ["production", "base"],
    "static_egress_ip": false,
    "pipeline_config": {
      "source": {
        "type": "pubsub",
        "chain": "base",
        "entity": "erc20_token_transfer",
        "is_zerolag": false
      },
      "transforms": [
        {
          "type": "redis_set_filter",
          "uid": "tf-001",
          "filter_expr": "root = this.token_address"
        }
      ],
      "sinks": [
        {
          "type": "kafka",
          "uid": "sk-001",
          "name": "usdc-transfers"
        }
      ]
    }
  }
]

Authorizations

X-API-KEY

string

header

required

Response

Successful Response

string

required

name

string

required

description

string

required

owner_org_team_user_id

string

required

pipeline_config

BeamPipelineConfig · object

required

Show child attributes

organization_id

string | null

created_at

string<date-time>

updated_at

string<date-time>