---
title: "List Workflows"
method: GET
path: "/v1/templates"
tags: ["Workflows"]
---

# List Workflows

`GET /v1/templates`

## Request

- Base URL: `https://api.documentpro.ai`
- URL: `https://api.documentpro.ai/v1/templates`
- Auth: API key in header `x-api-key`

## Query parameters

- `pagination_key` string

## Response `200`

Paginated list of Workflows. Up to 50 per page.

- object
  - `success` boolean
  - `items` Workflow[]
    - `template_id` string, uuid: template_id and workflow_id are used interchangeably.
    - `template_title` string
    - `template_type` string
    - `template_category` string
    - `template_schema` TemplateSchema
      - `fields` TemplateField[]
        - `name` string, required: Lowercase letters, numbers, or underscore only.
        - `type` 'text' | 'number' | 'date' | 'table', required
        - `description` string
        - `required` boolean
        - `subFields` object[]: Required (at least one entry) when type is table.
          - `name` string, required
          - `type` 'text' | 'number' | 'date', required
          - `description` string
          - `required` boolean
    - `email_id` string, email: Auto-generated address for forwarding documents to this Workflow.
    - `webhook_url` string, uri, nullable
    - `parser_config` ParserConfig
      - `parse_email_attachments` boolean
      - `parse_email_body` boolean
      - `date_format` string, nullable
      - `ocr_config` object
        - `use_ocr` boolean
        - `detect_layout` boolean
        - `detect_tables` boolean
        - `remove_headers` boolean
        - `remove_footers` boolean
        - `remove_tables` boolean
      - `query_config` object
        - `query_model` string
        - `page_ranges` string
        - `start_regex` string, nullable
        - `end_regex` string, nullable
        - `split_regex` string, nullable
        - `use_all_matches` boolean
    - `created_at` string, date-time
  - `pagination_key` string, nullable

## Other responses

- `400`: Malformed request or invalid arguments.
- `401`: Missing or invalid x-api-key.
- `403`: API key does not have access to the requested resource, or a plan limit was hit.
- `500`: Something went wrong on DocumentPro's side.

---

[API](https://skmtc.dev/documentpro/apis/documentpro-api.md) · [All operations](https://skmtc.dev/documentpro/apis/documentpro-api/llms.txt) · [OpenAPI document](https://skmtc.dev/documentpro/apis/documentpro-api/revisions/05d6bd485e28?raw)