Get workflow

curl --request GET \
  --url https://app.base44.com/api/apps/{app_id}/workflows/{workflow_id} \
  --header 'api_key: <api-key>'

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://app.base44.com/api/apps/{app_id}/workflows/{workflow_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.base44.com/api/apps/{app_id}/workflows/{workflow_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/apps/{app_id}/workflows/{workflow_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/apps/{app_id}/workflows/{workflow_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "68b1c0d4e7b91d003c45a1f2",
  "app_id": "6820f3a4e7b91d003c45a1f2",
  "name": "Email me new signups",
  "status": "active",
  "file_key": "email-me-new-signups",
  "description": "Sends an email whenever a User record is created.",
  "status_reason": "consecutive_failures",
  "current_version_id": "9f2c1a7b3e5d84f60c1b2a9e7d4f8c3b6a5e2d1f0c9b8a7e6d5c4b3a2f1e0d9c",
  "trigger": {
    "config": {
      "cron_expression": "0 9 * * *",
      "timezone": "UTC",
      "trigger_type": "scheduled"
    }
  },
  "app_type_context": {
    "app_type": "user_app"
  },
  "last_run_at": "2026-08-25T09:12:44Z",
  "last_run_status": "success",
  "consecutive_failures": 0,
  "total_runs": 48,
  "successful_runs": 44,
  "failed_runs": 3,
  "created_date": "2026-07-02T11:04:00Z",
  "updated_date": "2026-08-20T16:31:00Z",
  "created_by": "you@example.com",
  "definition": {
    "do": [],
    "document": {
      "dsl": "1.0.0",
      "name": "notify",
      "version": "1.0.0"
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Workflows

Get workflow

This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.

Reads one workflow, including the full definition it currently runs.

This is the only endpoint that returns definition. The list endpoint leaves it out.

This endpoint is limited to 60 requests per minute.

The response includes fields beyond the ones documented here. Don’t rely on undocumented response fields, as they can change at any time.

This endpoint accepts a personal API key. Workspace API keys are not authorized for it and are rejected with a 403.

GET

api

apps

{app_id}

workflows

{workflow_id}

Get workflow

curl --request GET \
  --url https://app.base44.com/api/apps/{app_id}/workflows/{workflow_id} \
  --header 'api_key: <api-key>'

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://app.base44.com/api/apps/{app_id}/workflows/{workflow_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.base44.com/api/apps/{app_id}/workflows/{workflow_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/apps/{app_id}/workflows/{workflow_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/apps/{app_id}/workflows/{workflow_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "68b1c0d4e7b91d003c45a1f2",
  "app_id": "6820f3a4e7b91d003c45a1f2",
  "name": "Email me new signups",
  "status": "active",
  "file_key": "email-me-new-signups",
  "description": "Sends an email whenever a User record is created.",
  "status_reason": "consecutive_failures",
  "current_version_id": "9f2c1a7b3e5d84f60c1b2a9e7d4f8c3b6a5e2d1f0c9b8a7e6d5c4b3a2f1e0d9c",
  "trigger": {
    "config": {
      "cron_expression": "0 9 * * *",
      "timezone": "UTC",
      "trigger_type": "scheduled"
    }
  },
  "app_type_context": {
    "app_type": "user_app"
  },
  "last_run_at": "2026-08-25T09:12:44Z",
  "last_run_status": "success",
  "consecutive_failures": 0,
  "total_runs": 48,
  "successful_runs": 44,
  "failed_runs": 3,
  "created_date": "2026-07-02T11:04:00Z",
  "updated_date": "2026-08-20T16:31:00Z",
  "created_by": "you@example.com",
  "definition": {
    "do": [],
    "document": {
      "dsl": "1.0.0",
      "name": "notify",
      "version": "1.0.0"
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

api_key

string

header

required

Personal API key.

Path Parameters

app_id

string

required

ID of the app whose workflows you want to work with.

workflow_id

string

required

ID of the workflow, as returned in id by List workflows.

Response

The workflow, including its current definition.

string

required

ID of the workflow.

Example:

"68b1c0d4e7b91d003c45a1f2"

app_id

string

required

ID of the app the workflow belongs to.

Example:

"6820f3a4e7b91d003c45a1f2"

name

string

required

Name of the workflow.

Example:

"Email me new signups"

status

string

required

Whether the workflow runs: active, inactive, or archived.

Example:

"active"

file_key

string | null

Name of the workflow's file in the app's code. null on workflows saved before files were kept.

Example:

"email-me-new-signups"

description

string | null

What the workflow is for.

Example:

"Sends an email whenever a User record is created."

status_reason

string | null

Why Base44 stopped the workflow itself, as a fixed code: consecutive_failures, end_condition_reached, migration_activation_failed, or workflows_not_available. null when you set the status yourself.

Example:

"consecutive_failures"

current_version_id

string | null

Version the workflow runs today, as the SHA-256 hash of that definition. null until a definition is saved.

Example:

"9f2c1a7b3e5d84f60c1b2a9e7d4f8c3b6a5e2d1f0c9b8a7e6d5c4b3a2f1e0d9c"

trigger

Trigger · object

What starts the workflow. The trigger sits under config, keyed by trigger_type.

Example:

{
  "config": {
    "cron_expression": "0 9 * * *",
    "timezone": "UTC",
    "trigger_type": "scheduled"
  }
}

app_type_context

App Type Context · object | null

Which app surface the workflow was authored against.

Example:

{ "app_type": "user_app" }

last_run_at

string<date-time> | null

When the workflow last started running. null before its first run.

Example:

"2026-08-25T09:12:44Z"

last_run_status

string | null

How that run ended: success, failed, or cancelled. null before the first run. Note this is a different set of values from a run's own status, which reports completed rather than success.

Example:

"success"

consecutive_failures

integer

default:0

Runs that have failed in a row. Resets on the next success.

Example:

0

total_runs

integer

default:0

Runs the workflow has started, ever.

Example:

48

successful_runs

integer

default:0

Runs that finished successfully, ever.

Example:

44

failed_runs

integer

default:0

Runs that ended in an error, ever.

Example:

3

created_date

string<date-time> | null

When the workflow was created.

Example:

"2026-07-02T11:04:00Z"

updated_date

string<date-time> | null

When the workflow was last changed.

Example:

"2026-08-20T16:31:00Z"

created_by

string | null

Email of whoever created the workflow.

Example:

"you@example.com"

definition

Definition · object | null

The steps the workflow runs, as a CNCF Serverless Workflow v1.0 document. null when no version has been saved yet. Only this endpoint returns it; the list endpoint does not.

Example:

{
  "do": [],
  "document": {
    "dsl": "1.0.0",
    "name": "notify",
    "version": "1.0.0"
  }
}

⌘I

App Management API (Beta)

Entities API (Beta)

Virality API (Beta)

Workflows API (Beta)

Analytics API (Beta)

Google Ads API (Beta)

Monitoring API

Audit Logs API

Get workflow

Authorizations

Path Parameters

Response