GET
/
workshops
/
{id}

Gets an existing workshop.

See the Workshop Guide to learn more.

Authorizations

​
lume-api-key
string
headerrequired

Path Parameters

​
id
string
required

Response

200 - application/json
​
id
string
required

The id of the workshop

​
user_id
string
required

The user id of the workshop

​
pipeline_id
string
required

The id of the pipeline the workshop is associated with

​
job_id
string
required

The id of the job the workshop is associated with

​
target_schema_id
string
required

The id of the target schema the workshop is associated with

​
source_schema_id
string
required

The id of the source schema the workshop is associated with

​
status
enum<string>
required

The status of the Workshop. This status will be set to 'deployed' if the workshop was most recently deployed. If the workshop has either not yet been deployed or has been run since last deployment, it will reflect the status of the most recent result

Available options:
created,
running,
finished,
failed,
needs review,
deployed
​
updated_at
string | null
required

The date and time this object was last updated

​
created_at
string
required

The date and time this object was created

​
global_context
string | null

The global context of the workshop