GET
/
v2
/
pipelines
/
{id}

Authorizations

lume-api-key
string
headerrequired

Path Parameters

id
required

The ID or name of the pipeline to retrieve.

Query Parameters

include
enum<string>[]
Available options:
target_schema,
transformations,
manifest
page
integer
default: 1
Required range: x > 1
size
integer
default: 50
Required range: 1 < x < 100

Response

200 - application/json

A pipeline organizes mapper versions that operate on the same source data schema. It is initialized with a mapper which can be edited iteratively to produce new versions. A single mapper version is active at a time.

id
string
required

The UUID of the pipeline.

user_id
string
required

The UUID of the user who created the pipeline.

name
string
required

The user-provided name of the pipeline.

created_at
string
required

The date and time this pipeline was created.

description
string | null

The user-provided description of the pipeline.

last_run_status
enum<string> | null

The status of the last run of the active mapper in the pipeline.

Available options:
QUEUED,
RUNNING,
FINISHED,
FAILED,
NEEDS REVIEW
mapper
object

A mapper is a set of transformation logic that maps data from a source schema to a target schema.

Update PipelineList Pipelines