Templates

List all templates

get/api/v1/templates

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/templates
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Query parameters

sandboxboolean

Filter by mode: true returns only sandbox (test) templates, false only live ones. Omit to return both.

collectionIdstring uuid
collectionIdsstring[]

Match any listed collection, without duplicate resources. Comma-separated UUIDs or repeated query parameters. Cannot be combined with collectionId or unassigned=true.

unassignedboolean

No memberships, including archived collections. Cannot be combined with collectionId or collectionIds.

includeCollectionsboolean

Include collectionIds for the returned page.

searchstring
Example:W-8BEN

Case-insensitive substring match against the template name and description.

isActiveboolean
sortBy'createdAt' | 'name' | 'status'
sortOrder'asc' | 'desc'
pagenumber

Page number (1-based)

limitnumber

Number of items per page

Response

totalnumber required

Total number of templates

pagenumber required

Current page number

limitnumber required

Number of items per page

totalPagesnumber required

Total number of pages

Example response

{
  "data": [
    {
      "formFieldsDetected": 23,
      "detectedMergeFields": [
        {
          "name": "client_name",
          "occurrences": 3
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.