How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Temporal Workflows API

Start, describe, list, count, and read the history of workflow executions.

Temporal Workflows API is one of 8 APIs that Temporal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 7 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://{namespace}.{account}.tmprl.cloud/api/v1, http://localhost:7243/api/v1.

7 operations 7 paths 9 schemas 6 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://docs.temporal.io/references/api-reference
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Temporal Workflows API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer API key. On Temporal Cloud, pass an API key as Authorization: Bearer . Self-hosted deployments may use mTLS instead. Requests are scoped to the namespac…

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 6 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Workflows 7

Start, describe, list, count, and read the history of workflow executions.

POST
/namespaces/{namespace}/workflows/{workflow_id}
Start a workflow execution
startWorkflowExecution 2 params body → 200401429
GET
/namespaces/{namespace}/workflows/{execution.workflow_id}
Describe a workflow execution
describeWorkflowExecution 3 params → 200401404
GET
/namespaces/{namespace}/workflows
List workflow executions
listWorkflowExecutions 4 params → 200401
GET
/namespaces/{namespace}/workflow-count
Count workflow executions
countWorkflowExecutions 2 params → 200401
GET
/namespaces/{namespace}/archived-workflows
List archived workflow executions
listArchivedWorkflowExecutions 4 params → 200401
GET
/namespaces/{namespace}/workflows/{execution.workflow_id}/history
Get workflow execution history
getWorkflowExecutionHistory 4 params → 200401404
GET
/namespaces/{namespace}/workflows/{execution.workflow_id}/history-reverse
Get workflow execution history (reverse)
getWorkflowExecutionHistoryReverse 4 params → 200401

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are StartWorkflowExecutionRequest (10 properties), GetWorkflowExecutionHistoryResponse (3 properties), Status (3 properties), ListWorkflowExecutionsResponse (2 properties). Each schema is shown below with its type and property counts.

Payloads
object
Temporal payloads envelope. Each payload carries base64-encoded metadata and data.
1 property
ListWorkflowExecutionsResponse
object
2 properties
StartWorkflowExecutionRequest
object
10 properties
DescribeWorkflowExecutionResponse
object
2 properties
WorkflowType
object
1 property
TaskQueue
object
2 properties
GetWorkflowExecutionHistoryResponse
object
3 properties
Status
object
A google.rpc.Status-style error payload.
3 properties
StartWorkflowExecutionResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

temporal-io-workflows-api-openapi.yml Raw ↑

Other APIs Temporal publishes across the network.

Temporal Operator Service API
Temporal Cloud Operations API
Temporal Nexus API
Temporal Cluster API
Temporal Namespaces API
Temporal Workflow Lifecycle API
Temporal Workflow Messaging API
Where this information came from

This is an independent, third-party profile of Temporal Workflows API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.