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

# Get a template

> Fetch one active template by its slug.



## OpenAPI

````yaml /api-reference/openapi.json get /templates/{template_slug}
openapi: 3.1.0
info:
  title: Vern Migration API
  version: 1.0.0
  description: >-
    Run Vern as a headless migration engine. Create a migration, upload a
    customer's files, run the managed agent to generate a preview, then execute
    and export clean data. See the Migration API guides for concepts and
    walkthroughs.


    **Rate limits** are counted per account (company), not per key or IP, in
    four classes: reads 30/minute, writes 30/minute, jobs (starting an export)
    15/hour, and agent calls (starting a run, answering, submitting credentials)
    30/hour. Creating a migration and starting a `generate` run each also have a
    30/hour cap. A `429` carries `Retry-After` plus `X-RateLimit-Limit`,
    `X-RateLimit-Remaining` and `X-RateLimit-Reset`.


    **Errors** are `{"error": "..."}`; some add a machine-readable `code` (e.g.
    `migration_archived`, `imports_in_flight`, `knowledge_too_long`,
    `storage_quota_exceeded`, `DOCUMENT_EXTRACTION_DISABLED`,
    `run_concurrency_limit`). An archived migration stays readable and
    exportable, but every call that changes it returns `409` with `code:
    migration_archived`.


    **Region**: accounts hosted in Australia use
    `https://au.app.vern.so/api/v1`. A key sent to the other region's base URL
    is answered `421` with `{"error", "code": "wrong_region", "region",
    "base_url", "mcp_url", "app_url"}` — switch to `base_url`.
servers:
  - url: https://app.vern.so/api/v1
    description: US-hosted accounts
  - url: https://au.app.vern.so/api/v1
    description: Australia-hosted accounts
security:
  - apiKey: []
tags:
  - name: Catalog
    description: Discover the sources and templates you set up in the Vern UI.
  - name: Migrations
    description: >-
      Create, list, update and archive migration workspaces, and upload a
      customer's files.
  - name: Runs
    description: 'Drive the managed agent: generate, refine, execute, answer, and observe.'
  - name: Export
    description: Download a migration's validated data as CSV.
  - name: Log
    description: The settled record of what a migration did.
  - name: Knowledge
    description: Durable context the agent reads before every run.
  - name: Exports
    description: Download imported data.
paths:
  /templates/{template_slug}:
    get:
      tags:
        - Catalog
      summary: Get a template
      description: Fetch one active template by its slug.
      operationId: getTemplate
      parameters:
        - name: template_slug
          in: path
          required: true
          schema:
            type: string
          example: contacts
      responses:
        '200':
          description: The template.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    Template:
      type: object
      properties:
        slug:
          type: string
          description: Stable public identifier.
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        columns:
          type: array
          items:
            $ref: '#/components/schemas/TemplateColumn'
    TemplateColumn:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
          maxLength: 500
          description: >-
            What the column holds. At most 500 characters for a new or changed
            value.
        required:
          type: boolean
        unique:
          type: boolean
        desiredRule:
          type: string
          enum:
            - none
            - ai
            - strict
            - link
        strictRule:
          type: string
          description: Regex the value must match (when desiredRule is strict).
        linkRule:
          type: array
          items:
            type: object
            properties:
              templateId:
                type: string
              columnName:
                type: string
          description: Cross-template references (when desiredRule is link).
    Error:
      type: object
      properties:
        error:
          type: string
          description: A human-readable error message.
        code:
          type: string
          description: >-
            A machine-readable code, on errors whose status alone is ambiguous
            (e.g. migration_archived, imports_in_flight, knowledge_too_long).
      required:
        - error
  responses:
    Unauthorized:
      description: API key missing, malformed, or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The referenced resource isn't in your account.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: >-
        Rate limit hit. Counted per account (company), not per API key or IP.
        Each endpoint is in one class: reads 30/minute, writes 30/minute, jobs
        (starting an export) 15/hour, agent (starting a run, answering,
        submitting credentials) 30/hour. Creating a migration and starting a
        `generate` run also have their own 30/hour caps. A separate per-IP
        ceiling absorbs floods before authentication. `Retry-After` gives the
        seconds until the window resets, alongside `X-RateLimit-Limit`,
        `X-RateLimit-Remaining` and `X-RateLimit-Reset`.
      headers:
        Retry-After:
          description: Seconds until the rate-limit window resets.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests allowed in the current window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix time (seconds) when the window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Too many requests
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your Vern API key. Create one at Settings → API keys.

````

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