Skip to main content
GET
Get Beams Handler
Returns every pipeline configuration you have read access to: pipelines you own, pipelines shared with you as an editor or reader, and pipelines whose viewer_team is one of your teams.
Required permission: read — owners, editors, readers, and members of teams shared via viewer_team.
Response: BeamConfig[]

Authorizations

X-API-KEY
string
header
required

Response

Successful Response

id
string
required
name
string
required
description
string
required
owner_org_team_user_id
string
required
pipeline_config
BeamPipelineConfig · object
required
organization_id
string | null
created_at
string<date-time>
updated_at
string<date-time>
tags
string[] | null
static_egress_ip
boolean
default:false
pod_size
enum<string>
default:XS
Available options:
XXS,
XS,
S,
M,
L,
XL
delivery_guarantee
enum<string>
default:at_least_once
Available options:
at_least_once,
best_effort