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

# List templates

> List available settlement templates with pagination. Only active templates are returned.



## OpenAPI

````yaml https://api-staging.keystoneos.xyz/openapi.json get /v1/settlement-templates
openapi: 3.1.0
info:
  title: Keystone API
  description: Settlement orchestration API for tokenized Real-World Assets (RWAs).
  version: 0.1.0
servers:
  - url: https://api.keystoneos.xyz
    description: Production
security:
  - bearerAuth: []
tags:
  - name: health
    description: Health and version checks.
  - name: platforms
    description: Register and manage your platform profile.
  - name: environments
    description: Manage platform environments (sandbox, production).
  - name: settlement-templates
    description: View and manage settlement templates.
  - name: settlements
    description: Initiate, monitor, and manage settlements.
  - name: sessions
    description: Create and manage browser-safe session tokens for frontend widgets.
  - name: instructions
    description: Submit and manage bilateral settlement instructions.
  - name: invitations
    description: Invite team members to your platform.
  - name: members
    description: Manage platform team members and roles.
  - name: webhooks
    description: Configure webhook endpoints for real-time event notifications.
  - name: security
    description: IP allowlisting and API access controls.
  - name: activity
    description: Audit trail of platform actions.
  - name: dashboard
    description: Dashboard metrics and statistics.
  - name: callbacks
    description: Provider callback handlers (internal).
  - name: alchemy-webhooks
    description: Alchemy blockchain event webhooks (internal).
  - name: chains
    description: Supported blockchain networks for settlement.
  - name: admin
    description: KeyStone internal administration endpoints.
  - name: admin-platforms
    description: Admin platform management.
  - name: admin-settlements
    description: Admin settlement oversight and intervention.
  - name: admin-compliance
    description: Admin compliance check management.
  - name: admin-activity
    description: Admin system-wide activity logs.
  - name: admin-webhooks
    description: Admin webhook diagnostics.
  - name: internal
    description: Keystone-internal worker endpoints.
  - name: internal-compliance
    description: Internal compliance engine endpoints.
paths:
  /v1/settlement-templates:
    get:
      tags:
        - settlement-templates
      summary: List templates
      description: >-
        List available settlement templates with pagination. Only active
        templates are returned.
      operationId: list_settlement_templates_v1_settlement_templates_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 50
            title: Limit
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_SettlementTemplateRead_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PaginatedResponse_SettlementTemplateRead_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SettlementTemplateRead'
          type: array
          title: Items
        total:
          type: integer
          title: Total
        limit:
          type: integer
          title: Limit
        offset:
          type: integer
          title: Offset
      type: object
      required:
        - items
        - total
        - limit
        - offset
      title: PaginatedResponse[SettlementTemplateRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SettlementTemplateRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        slug:
          type: string
          title: Slug
        name:
          type: string
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        config:
          $ref: '#/components/schemas/TemplateConfig'
        version:
          type: integer
          title: Version
        is_active:
          type: boolean
          title: Is Active
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - id
        - slug
        - name
        - description
        - config
        - version
        - is_active
        - created_at
        - updated_at
      title: SettlementTemplateRead
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    TemplateConfig:
      properties:
        states:
          items:
            type: string
          type: array
          title: States
        initial_state:
          type: string
          title: Initial State
        terminal_states:
          items:
            type: string
          type: array
          title: Terminal States
        failure_states:
          items:
            type: string
          type: array
          title: Failure States
        transitions:
          additionalProperties:
            $ref: '#/components/schemas/TransitionRule'
          type: object
          title: Transitions
        compliance:
          $ref: '#/components/schemas/ComplianceConfig'
          default:
            recheck_at_states: []
            entity_providers: []
            wallet_providers: []
        required_roles:
          items:
            type: string
          type: array
          title: Required Roles
          default:
            - seller
            - buyer
        actions:
          additionalProperties:
            $ref: '#/components/schemas/ActionConfig'
          type: object
          title: Actions
          default: {}
      type: object
      required:
        - states
        - initial_state
        - terminal_states
        - failure_states
        - transitions
      title: TemplateConfig
      description: |-
        Settlement workflow definition.

        Templates define the settlement process (states, transitions, actions,
        compliance rules, roles) but NOT integration specifics. Provider and
        platform details are determined at settlement creation time from the
        parties and legs, not from the template.
    TransitionRule:
      properties:
        allowed_next:
          items:
            type: string
          type: array
          title: Allowed Next
      type: object
      required:
        - allowed_next
      title: TransitionRule
    ComplianceConfig:
      properties:
        recheck_at_states:
          items:
            type: string
          type: array
          title: Recheck At States
          default: []
        entity_providers:
          items:
            type: string
          type: array
          title: Entity Providers
          default: []
        wallet_providers:
          items:
            type: string
          type: array
          title: Wallet Providers
          default: []
      type: object
      title: ComplianceConfig
    ActionConfig:
      properties:
        type:
          type: string
          title: Type
        provider:
          type: string
          title: Provider
        resolution:
          type: string
          enum:
            - immediate
            - webhook
            - poll
            - manual
          title: Resolution
          default: immediate
        timeout_seconds:
          type: integer
          exclusiveMinimum: 0
          title: Timeout Seconds
          default: 300
        params:
          additionalProperties: true
          type: object
          title: Params
          default: {}
      type: object
      required:
        - type
        - provider
      title: ActionConfig
      description: >-
        Defines what the system does when a settlement enters a state.


        Action type and provider are validated against the action handler
        registry

        at runtime - any (type, provider) pair with a registered handler is
        valid.

        This keeps the system extensible: new providers and action types can be

        added by registering handlers without modifying schema constants.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Auth0 JWT access token. See
        [Authentication](/getting-started/authentication) for details.

````