Skip to main content
GET
/
workflows
List Workflows
curl --request GET \
  --url https://api.promptlayer.com/workflows \
  --header 'X-API-KEY: <api-key>'
{
  "items": [
    {
      "id": 123,
      "workspace_id": 123,
      "name": "<string>",
      "is_deleted": true,
      "release_labels": [
        "<string>"
      ],
      "user_id": 123,
      "latest_version_number": 123,
      "external_ids": [
        {
          "source": "<string>",
          "external_id": "<string>"
        }
      ]
    }
  ],
  "page": 123,
  "per_page": 123,
  "pages": 123,
  "has_next": true,
  "has_prev": true,
  "total": 123,
  "next_num": 123,
  "prev_num": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.promptlayer.com/llms.txt

Use this file to discover all available pages before exploring further.

Get a list of all workflows in the system.

Authorizations

X-API-KEY
string
header
required

Query Parameters

page
integer
default:1

Page number for pagination.

Required range: x >= 1
per_page
integer
default:30

Number of items per page.

Required range: 1 <= x <= 100
created_by_email
string

Filter by the creator's email address.

created_after
string<date-time>

Filter resources created at or after this timestamp.

created_before
string<date-time>

Filter resources created at or before this timestamp.

updated_after
string<date-time>

Filter resources updated at or after this timestamp.

updated_before
string<date-time>

Filter resources updated at or before this timestamp.

external_source
string

External ID source to filter by. Must be provided with external_id.

external_id
string

External ID value to filter by. Must be provided with external_source.

sort_by
enum<string>

Sort field.

Available options:
created_at,
updated_at,
name,
id
sort_order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

Response

List of workflows retrieved successfully

items
object[]
required
page
integer
required

Current page number

per_page
integer
required

Number of items per page

pages
integer
required

Total number of pages

has_next
boolean
required

Whether there is a next page

has_prev
boolean
required

Whether there is a previous page

total
integer | null

Total number of items

next_num
integer | null

Next page number if available

prev_num
integer | null

Previous page number if available