Skip to content
Notavia Notavia Docs

Get a workflow by key

GET
/v1/workflows/{key}
 
curl --request GET \
  --url https://your-notavia-host/v1/workflows/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
key
required
string
/^[a-z][a-z0-9_]{0,99}$/

Workflow key — lowercase alphanumeric + underscore, max 100 chars.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Workflow detail returned.

Media type application/json
object
id
required
string format: uuid
key
required
string
name
required
string
description
string
nullable
status
required
string
Allowed values: draft active disabled
active_version
integer
nullable
active_body_json

Raw JSON body of the currently active version, or null if none.

string
nullable
created_at
required
string format: date-time
Example 
{
  "status": "draft"
}

401

Section titled “401 ”

Missing or invalid credentials.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

403

Section titled “403 ”

Credentials do not have the required scope.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

404

Section titled “404 ”

Resource not found.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}