> ## Documentation Index
> Fetch the complete documentation index at: https://docs.quentli.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get workflow

> Returns a workflow by id.



## OpenAPI

````yaml /openapi.yaml get /v1/workflows/{id}
openapi: 3.1.0
info:
  title: Quentli REST API
  version: 1.0.0
  description: OpenAPI spec for Quentli REST endpoints.
servers:
  - url: https://api.quentli.com
    description: Production API
  - url: https://api.staging.quentli.com
    description: Staging API for production-like validation
security:
  - organizationApiKey: []
  - oauthAccessToken: []
tags:
  - name: Auth
  - name: Management
  - name: Billing
  - name: Catalog
  - name: Customers
  - name: Invoices
  - name: Payment Methods
  - name: Payment Sessions
  - name: Payments
  - name: Subscriptions
  - name: Tax Invoices
  - name: Webhooks
  - name: Messaging
paths:
  /v1/workflows/{id}:
    get:
      tags:
        - Management
      summary: Get workflow
      description: Returns a workflow by id.
      operationId: workflows_get_by_id
      parameters:
        - schema:
            type: string
            description: Identifier of the workflow.
          required: true
          description: Identifier of the workflow.
          name: id
          in: path
      responses:
        '200':
          description: Workflow details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '404':
          description: Workflow not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
components:
  schemas:
    Workflow:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the workflow.
          example: wf_1234567890abcdefghij
        createdAt:
          type: string
          format: date-time
          description: When the workflow was created.
        updatedAt:
          type: string
          format: date-time
          description: >-
            When the workflow was last updated. Send it back as
            expectedUpdatedAt.
        organizationId:
          type: string
          description: Organization that owns the workflow.
        key:
          type: string
          description: Stable workflow key.
        name:
          type: string
          description: Name of the workflow.
          example: Cobranza estándar
        description:
          type:
            - string
            - 'null'
          description: Optional description of the workflow.
        status:
          type: string
          enum:
            - DRAFT
            - ACTIVE
            - PAUSED
          description: Whether the workflow runs on new events.
        publishedVersionId:
          type:
            - string
            - 'null'
          description: >-
            Currently published version. Send it back as
            expectedPublishedVersionId.
        deletedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When the workflow was deleted, if applicable.
      required:
        - id
        - createdAt
        - updatedAt
        - organizationId
        - key
        - name
        - description
        - status
        - publishedVersionId
        - deletedAt
      description: An automation that runs collection and reminder steps for invoices.
    UserError:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
          required:
            - message
      required:
        - error
      additionalProperties: false
      description: Standard user-facing error response envelope.
  securitySchemes:
    organizationApiKey:
      type: http
      scheme: bearer
      description: 'Organization API key using `Authorization: Bearer sk_...`.'
    oauthAccessToken:
      type: http
      scheme: bearer
      bearerFormat: OAuth 2.1
      description: 'OAuth access token using `Authorization: Bearer qoa_at_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.