Documentation

List Agents

Retrieve all agents in your organization

Retrieve all agents in your organization

Returns all agents (workflows) in your organization, including both active and archived. Each item includes summary fields — use Get an agent to retrieve the full workflow definition.

Quick reference#

Retrieve all agents in your organization. Send the request to GET /api/v1/workflow/fetch on the Paladin API base URL.

Method	`GET`
Path	`/api/v1/workflow/fetch`
Path parameters	None in the path.
Authentication	Use the authentication method shown in the OpenAPI block and the Authentication docs. Keep API keys server-side.

Before you call#

Confirm you are using the production base URL shown in the API reference.
Make sure any path IDs belong to the same Paladin organization as the credential you are using.
Validate request bodies and required fields before sending production traffic.

Common error checks#

Use 401 or 403 responses to check credentials, organization scope, and permissions.
Use 404 responses to check whether the referenced resource exists in the current organization.
Use 422 responses to inspect missing or invalid request fields.

OpenAPI#

GET /api/v1/workflow/fetch

openapi: 3.1.0
info:
  title: Paladin API
  description: API for the Paladin app
  version: 1.0.0
servers:
  - url: https://app.paladin.northmanngrp.com
    description: Production

security: []
paths:
  /api/v1/workflow/fetch:
    get:
      tags:
        - main
      summary: Get Workflows
      description: |-
        Get all workflows for the authenticated user's organization.

        Returns a lightweight response with only essential fields for listing.
        Use GET /workflow/fetch/{workflow_id} to get full workflow details.
      operationId: get_workflows_api_v1_workflow_fetch_get
      parameters:
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Filter by status - can be single value (active/archived) or
              comma-separated (active,archived)
            title: Status
          description: >-
            Filter by status - can be single value (active/archived) or
            comma-separated (active,archived)
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkflowListResponse'
                title: Response Get Workflows Api V1 Workflow Fetch Get
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WorkflowListResponse:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        status:
          type: string
          title: Status
        created_at:
          type: string
          format: date-time
          title: Created At
        total_runs:
          type: integer
          title: Total Runs
        folder_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Folder Id
        workflow_uuid:
          anyOf:
            - type: string
            - type: 'null'
          title: Workflow Uuid
      type: object
      required:
        - id
        - name
        - status
        - created_at
        - total_runs
      title: WorkflowListResponse
      description: Lightweight response for workflow listings (excludes large fields).
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError