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

# Show a Contract Template

> Retrieve a contract template by its ID. Archived contract templates are not returned.

Required authorization scope: `public.contract_template:read`




## OpenAPI

````yaml /2025-09/openapi.json get /2025-09/contract_templates/{contract_template_id}
openapi: 3.1.1
info:
  version: 2025-09
  title: Stora Public API
  description: >-
    The Stora Public API gives you programmatic access to your self-storage
    business. Use it to build custom integrations, automate operational
    workflows, and sync data with the tools you already use.
  termsOfService: https://www.stora.co/terms-of-service
  contact:
    name: Stora Support
    url: https://www.stora.co/contact
  x-build-date: '2025-02-22'
servers:
  - url: https://public-api.stora.co
    description: Production
security: []
tags:
  - name: Contacts
    description: >-
      Contact is the end user of an operator's storage business, an individual
      or company, used to manage everyone who inquires, books, signs contracts,
      and pays for storage. Use Staff instead for the operator's own team.
  - name: Contract Templates
    description: >-
      Contract Template is a reusable contract blueprint, used to generate
      contracts for a specific contact and tenancy. It contains the contract
      content with fillable fields and variables that Stora can pre-fill at
      document generation time.
  - name: Contracts
    description: >-
      Contract is a document generated from a contract template for a specific
      contact, used to track the signing lifecycle. It moves through statuses
      such as pending, signed, voided, declined, and deleted.
  - name: Coupons
    description: >-
      Coupon is a reusable promotion, used to reduce the price a contact pays by
      either a percentage or a fixed amount. It can be applied to eligible
      charges such as unit rent or products and may be limited by duration,
      number of uses, or scope. Use Price Adjustments instead to change an
      existing subscription's recurring price.
  - name: Credit Notes
    description: >-
      Credit Note is a document that reduces or reverses part or all of a
      previously issued invoice, used to correct what a contact was charged. It
      references the original invoice and contact, along with the specified
      corrected amounts and taxes.
  - name: Deals
    description: >-
      Deal is a qualified sales lead for a contact, used to track a potential
      rental through pipeline stages until it is won or lost. Use Opportunities
      instead to capture early interest before it is qualified, and Orders once
      the contact is ready to book with agreed pricing.
  - name: Deals / Stages
    description: >-
      Deal Stage is a step in the operator's sales pipeline, used to show how
      far a deal has progressed. Stages are configured in the Stora back office
      and are read-only through the API.
  - name: Identity Verifications
    description: >-
      Identity Verification is a check of a contact's identity documents, used
      to confirm who is renting before move-in. It records the verification's
      status, the reason it failed, and the contact it belongs to.
  - name: Images
    description: >-
      Image is a picture of a resource such as a site or unit type, used to
      display that resource in your own app or website. The endpoint redirects
      to a temporary pre-signed storage URL where the image can be downloaded.
  - name: Invoices
    description: >-
      Invoice is a finalized billing document issued to a contact, used to
      charge for their storage subscriptions and related charges. It itemizes
      line items like unit rent and protection, applies taxes and discounts, and
      tracks totals, balance due, and status over time.
  - name: Notes
    description: >-
      Note is a free-text annotation on a contact, unit, subscription, or task,
      used to record observations and context added by staff or integrations.
      Use Timeline Events instead to show structured activity from an external
      system on a resource's timeline.
  - name: OAuth 2
    description: >-
      OAuth 2 is the authorization standard of the Stora Public API, used to get
      the access token that authenticates every request. Use the **Client
      Credentials** flow if you are an operator building your own integration.
      Use the **Authorization Code** flow if you are a partner integrating on
      behalf of an operator.
  - name: Opportunities
    description: >-
      Opportunity is an expression of interest in storage, used to capture leads
      before they are qualified. Examples include an incomplete order, a price
      reveal, a quote request, or a lead captured before a site opens. Use Deals
      instead once the lead is qualified, and Orders once the contact is ready
      to book. It records the contact, the site and storage they were interested
      in, and can go on to be associated with a deal.
  - name: Orders
    description: >-
      Order is a contact's request to rent storage, used to book a unit type at
      a site with a move-in date and agreed pricing. Use Deals instead for leads
      that aren't ready to book. It includes optional add-ons like protection,
      products, and services and tracks status over its lifecycle. An order
      becomes `completed` when Stora creates its subscription and tenancy from
      it.
  - name: Orders / Line Items
    description: >-
      Order Line Item is an individual charge in an order, used to itemize what
      the contact will pay. Each line item represents a product or service such
      as unit rent, protection, or a one-off fee, and includes its quantity,
      unit price, and currency.
  - name: Price Adjustments
    description: >-
      Price Adjustment is a scheduled percentage change (increase or decrease)
      to a subscription's recurring prices, used to change what a contact pays
      from a future renewal date. It tracks its lifecycle from scheduling
      through application and invoicing, along with contact notification
      details. Use Coupons instead for promotional discounts.
  - name: Product Categories
    description: >-
      Product Category is a group of related products and services, used to
      classify them for pricing and display.
  - name: Products
    description: >-
      Product is a sellable item or service offered by the operator, used to
      sell extras alongside storage. It defines attributes such as name,
      description, pricing model, currency, and category, which determine how
      it's presented and billed. Use Protection Levels instead for coverage
      add-ons.
  - name: Protection Levels
    description: >-
      Protection Level is an optional add-on that protects a contact's stored
      goods up to a chosen coverage amount, used to offer coverage alongside
      storage. It's priced and billed alongside storage, appears as its own
      product or line item, and follows the same tax and discount rules as other
      charges.


      Each protection level belongs to one site. Global levels (`site` is
      `null`) stay readable for historical references, but you can't use them on
      new order or deal line items. See [Migrating to site-scoped protection
      levels](https://docs.stora.co/2025-09/guides/site-scoped-protection-levels).
  - name: Sites
    description: >-
      Site is a single physical self-storage location, used to scope units, unit
      types, pricing, and access control to that location. It's the container
      for everything specific to that location, including taxes and reporting.
  - name: Staff
    description: >-
      Staff is a member of the operator's team who uses the Stora back office,
      used to assign tasks and deals and to see who created a record.
  - name: Subscriptions
    description: >-
      Subscription is the recurring billing agreement for a contact's rental,
      used to charge them on a schedule for storage and related services. It
      defines the billing period and active prices, accrues charges into
      invoices, and reflects proration, discounts, and taxes. Use Tenancies
      instead for the physical side of the same rental.
  - name: Tasks
    description: >-
      Task is a to-do for staff, optionally linked to a unit, contact, or
      subscription, used to track follow-ups and operational work. Tasks are
      `open` or `completed` and can be assigned to a staff member.
  - name: Tenancies
    description: >-
      Tenancy is the storage agreement between a contact and the operator, used
      to see who rents which units at which site and for which dates. Use
      Subscriptions instead for the billing side of the same rental.
  - name: Timeline / Events
    description: >-
      Timeline Event is a custom entry from an external integration, used to
      show CRM, messaging, or other system activity on a resource's timeline.
      Use Notes instead for free-text annotations. An event can link to a
      contact, site, subscription, tenancy, unit, invoice, or unit type.
  - name: Timeline / Sources
    description: >-
      Timeline Source is the external system a timeline event comes from, such
      as a CRM or a custom integration, used to label and group events.
  - name: Timeline / Templates
    description: >-
      Timeline Template is the Liquid message format for a timeline event, used
      to render the event's text from its variables.
  - name: Unit Allocations
    description: >-
      Unit Allocation is the assignment of a specific unit to a tenancy, used to
      track when the unit was reserved and when the contact was granted access.
      Use Units instead for the unit's own details and status.
  - name: Unit Types
    description: >-
      Unit Type is a standardized storage offering at a site, such as "50 sq ft
      indoor" or "20 ft container", used to set pricing and show availability.
      It defines core attributes including size, features or access type, and
      display name.
  - name: Units
    description: >-
      Unit is a specific, bookable storage space at a site, for example "Unit
      A-012" of a given unit type, used to track each individual space and its
      status. Use Unit Allocations instead to see which tenancy a unit is
      assigned to.
  - name: Webhook Endpoints
    description: >-
      Webhook Endpoint is a URL you register with Stora, used to receive
      notifications when specific events occur. Use Webhooks instead for the
      event payloads Stora sends. Stora sends a `POST` request to the endpoint
      with the event payload.
  - name: Webhooks
    description: >-
      Webhook is an event notification that Stora sends as a `POST` request to
      your subscribed endpoints, used to react in real time when something
      happens, such as an invoice being paid. Use Webhook Endpoints instead to
      register the URLs that receive them. Stora sends each notification to all
      endpoints subscribed to that event type.
externalDocs:
  description: Stora Public API documentation website
  url: https://docs.stora.co/2025-09/
paths:
  /2025-09/contract_templates/{contract_template_id}:
    parameters:
      - name: contract_template_id
        in: path
        required: true
        description: The ID of the contract template
        schema:
          type: string
          pattern: ^ctpl_
    get:
      tags:
        - Contract Templates
      summary: Show a Contract Template
      description: >
        Retrieve a contract template by its ID. Archived contract templates are
        not returned.


        Required authorization scope: `public.contract_template:read`
      operationId: contract_template_show
      parameters:
        - name: fields
          in: query
          required: false
          description: >-
            Returns only the listed fields, such as `id,status,site.name`.
            Identifiers and constant fields such as `object` are always
            returned. A field inside an expandable association also needs it in
            `expand`, unless the collapsed association returns it, such as
            `site.id`. For more, see the [documentation
            page](https://docs.stora.co/2025-09/guides/responses#selecting-fields).
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: contract template
          content:
            application/json:
              examples:
                default:
                  value:
                    contract_template:
                      id: ctpl_33ae8d0b2b371ba2
                      created_at: '2025-02-22T14:41:00Z'
                      name: Sample Contract Template
                      updated_at: '2025-02-22T14:41:00Z'
                    meta:
                      request_id: 01563646-58c1-4607-8fe0-cae3e92c4477
                      curies:
                        - name: bo
                          href: https://app.stora.test{rel}
                          templated: true
                          title: Backoffice
                        - name: sf
                          href: https://acme.stora.test{rel}
                          templated: true
                          title: Storefront
                  summary: contract template
              schema:
                $ref: '#/components/schemas/ContractTemplateSingle'
        '404':
          description: contract template not found
          content:
            application/json:
              examples:
                default:
                  value:
                    error:
                      code: resource_not_found
                      details: []
                      links:
                        - kind: api_reference
                          name: Show a Contract Template
                          url: >-
                            https://docs.stora.test/2025-09/api-reference/contract-templates/show-a-contract-template
                        - kind: open_api
                          name: OpenAPI specification
                          url: https://docs.stora.test/2025-09/openapi.json
                        - kind: documentation
                          name: Errors
                          url: >-
                            https://docs.stora.test/2025-09/guides/errors#resource_not_found
                      message: The Contract Template was not found.
                      request_id: 01563646-58c1-4607-8fe0-cae3e92c4477
                      type: invalid_request_error
                  summary: contract template not found
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: invalid path ID
          content:
            application/json:
              examples:
                invalid_path_id:
                  value:
                    error:
                      code: invalid_url_param
                      details:
                        - message: >-
                            value `invalid` at `/contract_template_id` does not
                            match pattern: ^ctpl_
                          pointer: /contract_template_id
                      links:
                        - kind: api_reference
                          name: Show a Contract Template
                          url: >-
                            https://docs.stora.test/2025-09/api-reference/contract-templates/show-a-contract-template
                        - kind: open_api
                          name: OpenAPI specification
                          url: https://docs.stora.test/2025-09/openapi.json
                        - kind: documentation
                          name: Errors
                          url: >-
                            https://docs.stora.test/2025-09/guides/errors#invalid_url_param
                      message: The request URL param is invalid.
                      request_id: 01563646-58c1-4607-8fe0-cae3e92c4477
                      type: invalid_request_error
                  summary: invalid path ID
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - Bearer:
            - public.contract_template:read
        - OAuth2:
            - public.contract_template:read
components:
  schemas:
    ContractTemplateSingle:
      type: object
      required:
        - contract_template
        - meta
      properties:
        contract_template:
          $ref: '#/components/schemas/ContractTemplate'
        meta:
          $ref: '#/components/schemas/Meta'
      additionalProperties: false
      description: Single Contract Template
    Error:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorObject'
      additionalProperties: false
      description: Error
    ContractTemplate:
      type: object
      description: Contract Template
      required:
        - id
        - created_at
        - name
        - updated_at
      properties:
        id:
          type: string
          pattern: ^ctpl_
          description: Unique identifier for the contract template (`ctpl_…`).
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the contract template.
        name:
          type: string
          description: Name of the contract template.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the contract template.
      additionalProperties: false
    Meta:
      type: object
      required:
        - curies
        - request_id
      properties:
        curies:
          type: array
          items:
            $ref: '#/components/schemas/Curie'
          description: CURIE definitions for resolving namespaced link relations.
        request_id:
          type: string
          description: Unique request identifier.
      additionalProperties: false
    ErrorObject:
      type: object
      description: Error
      required:
        - code
        - details
        - links
        - message
        - request_id
        - type
      properties:
        code:
          type: string
          description: Short code that represents the error.
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
          description: Array of error details.
        links:
          type: array
          items:
            $ref: '#/components/schemas/ErrorsLink'
          description: Link(s) to Stora developer resources
        message:
          type: string
          description: Human-readable message providing brief information about the error.
        request_id:
          type: string
          description: Unique request identifier.
        type:
          type: string
          enum:
            - invalid_request_error
            - api_error
          description: Type of error returned.
      additionalProperties: false
    Curie:
      type: object
      description: CURIE definition for resolving namespaced link relations.
      required:
        - href
        - name
        - templated
        - title
      properties:
        href:
          type: string
          description: URI template for resolving the CURIE.
        name:
          type: string
          enum:
            - bo
            - sf
          description: CURIE prefix name
        templated:
          type: boolean
          description: Whether the href is a URI template.
        title:
          type: string
          description: Human-readable title.
      additionalProperties: false
    ErrorDetail:
      type: object
      description: ErrorDetail
      required:
        - message
        - pointer
      properties:
        message:
          type: string
          description: >-
            Human-readable message providing detailed information about the
            error.
        pointer:
          type:
            - string
            - 'null'
          description: >
            Points to the request field that caused the error:

            - String starting with '/': Exact path of the problematic field.

            - String starting without '/': General hint, cannot pinpoint exact
            field.

            - null: Error cannot be mapped to any specific field.
      additionalProperties: false
    ErrorsLink:
      type: object
      description: Link to Stora developer resources
      required:
        - kind
        - name
        - url
      properties:
        kind:
          type: string
          description: Kind of Stora documentation
        name:
          type: string
          description: Name of Stora documentation
        url:
          type: string
          format: uri
          description: URL to Stora documentation
      additionalProperties: false
  securitySchemes:
    Bearer:
      description: Bearer Token necessary to use API
      type: http
      scheme: bearer
      bearerFormat: token
    OAuth2:
      type: oauth2
      description: OAuth 2 authentication
      flows:
        clientCredentials:
          tokenUrl: https://public-api.stora.co/oauth2/token
          scopes:
            public.access_token:read: Access Token (Read)
            public.application:read: Application (Read)
            public.contact:read: Contact (Read)
            public.contact:write: Contact (Write)
            public.contract:read: Contract (Read)
            public.contract_template:read: Contract Template (Read)
            public.coupon:read: Coupon (Read)
            public.credit_note:read: Credit Note (Read)
            public.deal:read: Deal (Read)
            public.deal:write: Deal (Write)
            public.deal_stage:read: Deal Stage (Read)
            public.identity_verification:read: Identity Verification (Read)
            public.invoice:read: Invoice (Read)
            public.note:read: Note (Read)
            public.note:write: Note (Write)
            public.opportunity:read: Opportunity (Read)
            public.opportunity:write: Opportunity (Write)
            public.order:read: Order (Read)
            public.order:write: Order (Write)
            public.price_adjustment:read: Price Adjustment (Read)
            public.price_adjustment:skip_notifications: Price Adjustment (Skip notifications)
            public.price_adjustment:write: Price Adjustment (Write)
            public.product:read: Product (Read)
            public.product:write: Product (Write)
            public.product_category:read: Product Category (Read)
            public.protection_level:read: Protection Level (Read)
            public.protection_level:write: Protection Level (Write)
            public.site:read: Site (Read)
            public.staff:read: Staff (Read)
            public.subscription:read: Subscription (Read)
            public.task:read: Task (Read)
            public.task:write: Task (Write)
            public.tenancy:read: Tenancy (Read)
            public.timeline_event:read: Timeline Event (Read)
            public.timeline_event:write: Timeline Event (Write)
            public.timeline_source:read: Timeline Source (Read)
            public.timeline_template:read: Timeline Template (Read)
            public.unit:read: Unit (Read)
            public.unit:write: Unit (Write)
            public.unit_allocation:read: Unit Allocation (Read)
            public.unit_type:read: Unit Type (Read)
            public.unit_type:write: Unit Type (Write)
            public.webhook_endpoint:read: Webhook Endpoint (Read)
            public.webhook_endpoint:write: Webhook Endpoint (Write)
        authorizationCode:
          authorizationUrl: https://app.stora.co/oauth2/authorize
          tokenUrl: https://public-api.stora.co/oauth2/token
          scopes:
            public.access_token:read: Access Token (Read)
            public.application:read: Application (Read)
            public.contact:read: Contact (Read)
            public.contact:write: Contact (Write)
            public.contract:read: Contract (Read)
            public.contract_template:read: Contract Template (Read)
            public.coupon:read: Coupon (Read)
            public.credit_note:read: Credit Note (Read)
            public.deal:read: Deal (Read)
            public.deal:write: Deal (Write)
            public.deal_stage:read: Deal Stage (Read)
            public.identity_verification:read: Identity Verification (Read)
            public.invoice:read: Invoice (Read)
            public.note:read: Note (Read)
            public.note:write: Note (Write)
            public.opportunity:read: Opportunity (Read)
            public.opportunity:write: Opportunity (Write)
            public.order:read: Order (Read)
            public.order:write: Order (Write)
            public.price_adjustment:read: Price Adjustment (Read)
            public.price_adjustment:skip_notifications: Price Adjustment (Skip notifications)
            public.price_adjustment:write: Price Adjustment (Write)
            public.product:read: Product (Read)
            public.product:write: Product (Write)
            public.product_category:read: Product Category (Read)
            public.protection_level:read: Protection Level (Read)
            public.protection_level:write: Protection Level (Write)
            public.site:read: Site (Read)
            public.staff:read: Staff (Read)
            public.subscription:read: Subscription (Read)
            public.task:read: Task (Read)
            public.task:write: Task (Write)
            public.tenancy:read: Tenancy (Read)
            public.timeline_event:read: Timeline Event (Read)
            public.timeline_event:write: Timeline Event (Write)
            public.timeline_source:read: Timeline Source (Read)
            public.timeline_template:read: Timeline Template (Read)
            public.unit:read: Unit (Read)
            public.unit:write: Unit (Write)
            public.unit_allocation:read: Unit Allocation (Read)
            public.unit_type:read: Unit Type (Read)
            public.unit_type:write: Unit Type (Write)
            public.webhook_endpoint:read: Webhook Endpoint (Read)
            public.webhook_endpoint:write: Webhook Endpoint (Write)

````

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