> ## 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 Deal

> Retrieve one deal by its ID. Expand `contact`, `stage`, `site` or `assignee` to fetch them in the same request.

Required authorization scope: `public.deal:read`




## OpenAPI

````yaml /2025-09/openapi.json get /2025-09/deals/{deal_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/deals/{deal_id}:
    parameters:
      - name: deal_id
        in: path
        required: true
        description: The ID of the deal
        schema:
          type: string
          pattern: ^deal_
    get:
      tags:
        - Deals
      summary: Show a Deal
      description: >
        Retrieve one deal by its ID. Expand `contact`, `stage`, `site` or
        `assignee` to fetch them in the same request.


        Required authorization scope: `public.deal:read`
      operationId: deal_show
      parameters:
        - name: expand
          in: query
          required: false
          description: >-
            This endpoint supports expandable responses. For more, see the
            [documentation
            page](https://docs.stora.co/2025-09/guides/responses#expanding-responses).
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
        - 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: deal detail
          content:
            application/json:
              examples:
                default:
                  value:
                    deal:
                      id: deal_127b3057d5df338e
                      assignee:
                        id: staff_947b3057d5df338e
                      contact:
                        id: con_1234567890abcdef
                      created_at: '2025-02-22T14:41:00Z'
                      creator:
                        id: staff_947b3057d5df338e
                      line_items:
                        - item:
                            id: plvl_e8f3ad0a07e47566
                          quantity: 1
                          type: protection
                        - item:
                            id: utype_f18fc91387cdf710
                          quantity: 1
                          type: unit_type
                      lost_reason: null
                      metadata: {}
                      name: First Deal
                      note: £50 per month
                      site:
                        id: site_14b419f1096013f1
                      stage:
                        id: dstg_127b3057d5df338e
                      starts_at: null
                      status: open
                      updated_at: '2025-02-22T14:41:00Z'
                      value_estimate: £50 per month
                    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: deal detail
                deleted_stage:
                  value:
                    deal:
                      id: deal_227b3057d5df338e
                      assignee: null
                      contact:
                        id: con_1234567890abcdef
                      created_at: '2025-02-22T14:41:00Z'
                      creator:
                        id: staff_947b3057d5df338e
                      line_items:
                        - item:
                            id: plvl_e8f3ad0a07e47566
                          quantity: 1
                          type: protection
                        - item:
                            id: utype_f18fc91387cdf710
                          quantity: 1
                          type: unit_type
                      lost_reason: null
                      metadata: {}
                      name: Archived Deal
                      note: £50 per month
                      site:
                        id: site_14b419f1096013f1
                      stage:
                        created_at: '2025-02-22T14:41:00Z'
                        name: Second Stage - (Deleted)
                        position: 2
                        updated_at: '2025-02-22T14:41:00Z'
                      starts_at: null
                      status: open
                      updated_at: '2025-02-22T14:41:00Z'
                      value_estimate: £50 per month
                    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: deal detail (with deleted stage)
                expanded:
                  value:
                    deal:
                      id: deal_127b3057d5df338e
                      assignee:
                        id: staff_947b3057d5df338e
                        created_at: '2025-02-22T14:41:00Z'
                        email: john@doe.com
                        name: John Doe
                        updated_at: '2025-02-22T14:41:00Z'
                      contact:
                        id: con_1234567890abcdef
                        accounting_code: ACC-CODE
                        address: null
                        company_registration_number: null
                        created_at: '2025-02-22T14:41:00Z'
                        email: example@email.com
                        full_name: Jane Doe
                        identity_check:
                          required: false
                          status: not_attempted
                        marketing_source: null
                        metadata: {}
                        phone_number: null
                        source: null
                        status: lead
                        stripe_customer_id: null
                        tax_id: null
                        tenancies_count: 0
                        type: null
                        updated_at: '2025-02-22T14:41:00Z'
                        use_case: null
                      created_at: '2025-02-22T14:41:00Z'
                      creator:
                        id: staff_947b3057d5df338e
                        created_at: '2025-02-22T14:41:00Z'
                        email: john@doe.com
                        name: John Doe
                        updated_at: '2025-02-22T14:41:00Z'
                      line_items:
                        - item:
                            id: plvl_e8f3ad0a07e47566
                            account_code: null
                            cover_level:
                              amount: 2000000
                              currency: GBP
                              formatted: £20,000.00
                            created_at: '2025-02-22T14:41:00Z'
                            public: true
                            site:
                              id: site_14b419f1096013f1
                            stripe_product_id: test_Sj6us30iGDiaXO
                            updated_at: '2025-02-22T14:41:00Z'
                          quantity: 1
                          type: protection
                        - item:
                            id: utype_f18fc91387cdf710
                            _links:
                              sf:new_order:
                                href: >-
                                  /sites/site-name-self-storage-units/order/contact-details?unit_type_slug=standard-storage-unit
                                title: New order
                            created_at: '2025-02-22T14:41:00Z'
                            dimensions:
                              height: 11
                              length: 12
                              measurement_unit: ft
                              width: 10
                            dynamic_pricing: false
                            images:
                              default: null
                            live_prices:
                              - billing_period: monthly
                                price:
                                  amount: 1500
                                  currency: GBP
                                  formatted: £15.00
                                stripe_price_id: price_unit_type_live_123
                            name: Standard Storage Unit
                            promotion: null
                            require_insurance_coverage: true
                            require_security_deposit: true
                            security_deposit:
                              amount: 5000
                              currency: GBP
                              formatted: £50.00
                            selling_points:
                              - Spacious
                              - Affordable
                              - Secure
                            size_description: 10x12 ft
                            slug: standard-storage-unit
                            status: bookable
                            stripe_product_id: test_Sj6uOSWhCLm5et
                            updated_at: '2025-02-22T14:41:00Z'
                          quantity: 1
                          type: unit_type
                      lost_reason: null
                      metadata: {}
                      name: First Deal
                      note: £50 per month
                      site:
                        id: site_14b419f1096013f1
                        access_hours: null
                        address: null
                        created_at: '2025-02-22T14:41:00Z'
                        description: null
                        directions:
                          google_maps_url: null
                        images:
                          default: null
                        name: Site Name
                        opened_at: null
                        phone: '012345789'
                        updated_at: '2025-02-22T14:41:00Z'
                      stage:
                        id: dstg_127b3057d5df338e
                        created_at: '2025-02-22T14:41:00Z'
                        name: first
                        position: 1
                        updated_at: '2025-02-22T14:41:00Z'
                      starts_at: null
                      status: open
                      updated_at: '2025-02-22T14:41:00Z'
                      value_estimate: £50 per month
                    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: deal detail (fully expanded)
              schema:
                $ref: '#/components/schemas/DealSingle'
        '422':
          description: invalid path ID
          content:
            application/json:
              examples:
                invalid_path_id:
                  value:
                    error:
                      code: invalid_url_param
                      details:
                        - message: >-
                            value `invalid` at `/deal_id` does not match
                            pattern: ^deal_
                          pointer: /deal_id
                      links:
                        - kind: api_reference
                          name: Show a Deal
                          url: >-
                            https://docs.stora.test/2025-09/api-reference/deals/show-a-deal
                        - kind: documentation
                          name: Opportunities and deals
                          url: >-
                            https://docs.stora.test/2025-09/guides/opportunities-and-deals
                        - 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.deal:read
        - OAuth2:
            - public.deal:read
components:
  schemas:
    DealSingle:
      type: object
      required:
        - deal
        - meta
      properties:
        deal:
          $ref: '#/components/schemas/Deal'
        meta:
          $ref: '#/components/schemas/Meta'
      additionalProperties: false
      description: Single Deal
    Error:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorObject'
      additionalProperties: false
      description: Error
    Deal:
      type: object
      description: Deal
      required:
        - id
        - assignee
        - contact
        - created_at
        - creator
        - line_items
        - lost_reason
        - metadata
        - name
        - note
        - site
        - stage
        - starts_at
        - status
        - updated_at
        - value_estimate
      properties:
        id:
          type: string
          pattern: ^deal_
          description: Unique identifier for the deal (`deal_…`).
        assignee:
          anyOf:
            - $ref: '#/components/schemas/Staff'
            - $ref: '#/components/schemas/StaffCollapsed'
            - type: 'null'
          description: >-
            Staff member assigned to the deal. **Expandable** (shows only ID
            when not expanded).
        contact:
          anyOf:
            - $ref: '#/components/schemas/Contact'
            - $ref: '#/components/schemas/ContactCollapsed'
          description: >-
            Contact associated with the deal. **Expandable** (shows only ID when
            not expanded).
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the deal.
        creator:
          anyOf:
            - $ref: '#/components/schemas/Staff'
            - $ref: '#/components/schemas/StaffCollapsed'
            - $ref: '#/components/schemas/Creator'
            - $ref: '#/components/schemas/CreatorCollapsed'
            - type: 'null'
          description: >-
            Creator of the deal. Can be Staff, Access Token or Application.
            **Expandable** (shows only ID when not expanded).
        line_items:
          type: array
          items:
            $ref: '#/components/schemas/DealLineItem'
          description: >-
            List of line items associated with the deal. Each item references
            either a unit type or a protection level.
        lost_reason:
          type:
            - string
            - 'null'
          enum:
            - accessibility_concern
            - better_deal_elsewhere
            - chose_competitor
            - contract_terms
            - decided_not_to_use_storage
            - didnt_respond
            - due_to_unstaffed_site
            - facility_condition
            - financial_reasons
            - lack_of_response
            - location_issues
            - needs_extra_services
            - no_longer_needed
            - poor_customer_service
            - price_concerns
            - security_concerns
            - size_availability
            - timing
            - unable_to_reach_customer
            - unable_to_take_deliveries
            - other
            - null
          description: Reason for loss of deal if lost.
        metadata:
          type: object
          additionalProperties:
            type: string
          maxProperties: 20
          description: >-
            Set of key-value pairs for storing additional information. [Learn
            more about metadata.](https://docs.stora.co/2025-09/guides/metadata)
        name:
          type: string
          description: Name of the deal.
        note:
          type:
            - string
            - 'null'
          description: >-
            Free-text note for the deal. Displayed under 'Deal value estimate'
            in Backoffice.
        site:
          anyOf:
            - $ref: '#/components/schemas/Site'
            - $ref: '#/components/schemas/SiteCollapsed'
            - type: 'null'
          description: >-
            Site associated with the deal. **Expandable** (shows only ID when
            not expanded).
        stage:
          anyOf:
            - $ref: '#/components/schemas/DealStage'
            - $ref: '#/components/schemas/DealStageCollapsed'
            - type: 'null'
          description: >-
            Stage that the deal is currently in. **Expandable** (shows only ID
            when not expanded). Shows stage data with id omitted if the stage is
            deleted, noted by `- (Deleted)` in the `name` field.
        starts_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Intended move-in date, as an ISO 8601 date-time at midnight UTC.
            Only the date is meaningful.
        status:
          type: string
          enum:
            - open
            - won
            - lost
          description: Status of the deal.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the deal.
        value_estimate:
          type:
            - string
            - 'null'
          deprecated: true
          description: >-
            **Deprecated. Will be removed. Use `note` instead.** Estimate of the
            total value of this deal to the operator. It can cover storage fees
            alone, or storage, protection and any other services in the deal
            combined.
      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
    Staff:
      type: object
      description: Staff
      required:
        - id
        - created_at
        - email
        - name
        - updated_at
      properties:
        id:
          type: string
          pattern: ^staff_
          description: Unique identifier for the staff member (`staff_…`).
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the staff.
        email:
          type: string
          format: email
          description: Email address of the staff member.
        name:
          type: string
          description: Full name of the staff member.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the staff.
      additionalProperties: false
    StaffCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^staff_
          description: Unique identifier for the staff member (`staff_…`).
      additionalProperties: false
    Contact:
      type: object
      description: Contact
      required:
        - id
        - accounting_code
        - address
        - company_registration_number
        - created_at
        - email
        - full_name
        - identity_check
        - marketing_source
        - metadata
        - phone_number
        - source
        - status
        - stripe_customer_id
        - tax_id
        - tenancies_count
        - type
        - updated_at
        - use_case
      properties:
        id:
          type: string
          pattern: ^con_
          description: Unique identifier for the contact (`con_…`).
        accounting_code:
          type:
            - string
            - 'null'
          description: >-
            The contact's account reference in your accounting software,
            included in invoice exports.
        address:
          anyOf:
            - $ref: '#/components/schemas/ContactsAddress'
            - type: 'null'
          description: Address of the contact, `null` when no address is set.
        company_registration_number:
          type:
            - string
            - 'null'
          description: Company registration number of the contact.
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the contact.
        email:
          type: string
          format: email
          description: Email address of the contact.
        full_name:
          type: string
          description: Full name of the contact.
        identity_check:
          $ref: '#/components/schemas/ContactsIdentityCheck'
          description: Identity check requirement and status of the contact.
        marketing_source:
          type:
            - string
            - 'null'
          enum:
            - used_before
            - recommendation
            - received_leaflet
            - seen_building_signs
            - seen_advert
            - facebook_marketplace
            - google_search
            - other_online_search
            - social_media
            - email
            - radio
            - other
            - null
          description: Source of marketing for the contact.
        metadata:
          type: object
          additionalProperties:
            type: string
          maxProperties: 20
          description: >-
            Set of key-value pairs for storing additional information. [Learn
            more about metadata.](https://docs.stora.co/2025-09/guides/metadata)
        phone_number:
          type:
            - string
            - 'null'
          description: Phone number of the contact.
        source:
          type:
            - string
            - 'null'
          enum:
            - pre_open
            - incomplete_booking
            - registered_interest
            - price_interest
            - quotation_request
            - booking
            - popup
            - external_enquiry
            - phone
            - walkin
            - import
            - other
            - null
          description: Source of the contact information.
        status:
          type: string
          enum:
            - lead
            - customer
            - churned
          description: >-
            Status of the contact, derived from its tenancies. `lead` means the
            contact has no tenancies, and is the default. `customer` means at
            least one tenancy hasn't ended. `churned` means all tenancies have
            ended.
        stripe_customer_id:
          type:
            - string
            - 'null'
          deprecated: true
          description: >-
            **Deprecated. Will be removed in a future API version.** Stripe
            Customer identifier of the contact. Kept for backwards
            compatibility. Don't use it in new integrations.
        tax_id:
          type:
            - string
            - 'null'
          description: Tax identification number of the contact.
        tenancies_count:
          type: integer
          description: Number of tenancies associated with the contact.
        type:
          type:
            - string
            - 'null'
          enum:
            - domestic
            - company
            - student
            - charity
            - local_authority
            - null
          description: Type of the contact.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the contact.
        use_case:
          type:
            - string
            - 'null'
          enum:
            - business_needs
            - moving_home
            - more_space
            - refurb
            - travelling
            - other
            - null
          description: Use case for the contact.
      additionalProperties: false
    ContactCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^con_
          description: Unique identifier for the contact (`con_…`).
      additionalProperties: false
    Creator:
      type: object
      description: Access token or application
      required:
        - id
        - name
      properties:
        id:
          type: string
          description: Unique identifier for the access token or application.
        name:
          type: string
          description: Name of the access token or application.
      additionalProperties: false
    CreatorCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          description: Unique identifier for the access token or application.
      additionalProperties: false
    DealLineItem:
      type: object
      description: Deal Line Item
      required:
        - item
        - quantity
        - type
      properties:
        item:
          anyOf:
            - $ref: '#/components/schemas/UnitTypeExpandableWithoutPrices'
            - $ref: '#/components/schemas/UnitTypeCollapsed'
            - $ref: '#/components/schemas/ProtectionLevelExpandableWithoutPrices'
            - $ref: '#/components/schemas/ProtectionLevelCollapsed'
          description: >-
            Item associated with the line item. Can be a Unit type or Protection
            level. **Expandable** (shows only ID when not expanded).
        quantity:
          type: integer
          description: Quantity of the item in the deal line item.
        type:
          type: string
          enum:
            - unit_type
            - protection
          description: The kind of line item.
      additionalProperties: false
    Site:
      type: object
      description: Site
      required:
        - id
        - access_hours
        - address
        - created_at
        - description
        - directions
        - images
        - name
        - opened_at
        - phone
        - updated_at
      properties:
        id:
          type: string
          pattern: ^site_
          description: Unique identifier for the site (`site_…`).
        access_hours:
          anyOf:
            - $ref: '#/components/schemas/SitesAccessHours'
            - type: 'null'
          description: Access hours for the site.
        address:
          anyOf:
            - $ref: '#/components/schemas/SitesAddress'
            - type: 'null'
          description: Address of the site.
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the site.
        description:
          type:
            - string
            - 'null'
          description: Description of the site.
        directions:
          $ref: '#/components/schemas/SitesDirections'
          description: Directions to the site.
        images:
          type: object
          additionalProperties: false
          properties:
            default:
              type:
                - object
                - 'null'
              description: The `default` image, or `null` when none is uploaded.
              additionalProperties: false
              properties:
                original:
                  type: string
                  format: uri
                  description: Original unresized image.
                small:
                  type: string
                  format: uri
                  description: Resized to max 250x250px.
                medium:
                  type: string
                  format: uri
                  description: Resized to max 500x500px.
                large:
                  type: string
                  format: uri
                  description: Resized to max 1000x1000px.
          description: >-
            Image URLs keyed by image name. Each URL redirects to a short-lived
            download link, so don't cache the redirect target.
        name:
          type: string
          description: Name of the site.
        opened_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Date and time when the site opened or will open.
        phone:
          type:
            - string
            - 'null'
          description: Phone number of the site.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the site.
      additionalProperties: false
    SiteCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^site_
          description: Unique identifier for the site (`site_…`).
      additionalProperties: false
    DealStage:
      type: object
      description: Stage
      required:
        - created_at
        - name
        - position
        - updated_at
      properties:
        id:
          type: string
          pattern: ^dstg_
          description: Unique identifier for the stage (`dstg_…`).
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the stage.
        name:
          type: string
          description: Name of the stage. A deleted stage has ` - (Deleted)` appended.
        position:
          type: integer
          description: >-
            Numerical position in which the stage is placed in the defined deal
            journey.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the stage.
      additionalProperties: false
    DealStageCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^dstg_
          description: Unique identifier for the stage (`dstg_…`).
      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
    ContactsAddress:
      type: object
      description: Address
      required:
        - city
        - country_alpha2
        - line_1
        - line_2
        - postal_code
        - state
      properties:
        city:
          type:
            - string
            - 'null'
          description: City
        country_alpha2:
          type:
            - string
            - 'null'
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AQ
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HM
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MP
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - null
          description: Country Alpha 2
        line_1:
          type:
            - string
            - 'null'
          description: Line 1
        line_2:
          type:
            - string
            - 'null'
          description: Line 2
        postal_code:
          type:
            - string
            - 'null'
          description: Postal code
        state:
          type:
            - string
            - 'null'
          description: State or province, ISO 3166-2 only
      additionalProperties: false
    ContactsIdentityCheck:
      type: object
      description: Identity check of a contact
      required:
        - required
        - status
      properties:
        required:
          type: boolean
          description: >-
            Whether the contact is required to complete identity verification
            based on the operator's checkin settings.
        status:
          type: string
          enum:
            - failed
            - processing
            - succeeded
            - cancelled
            - not_attempted
          description: >-
            Status of the contact's latest identity verification.
            `not_attempted` is unique to this field (infers no identity
            verification resource yet exists for this contact).
      additionalProperties: false
    UnitTypeExpandableWithoutPrices:
      type: object
      description: Unit Type
      required:
        - id
        - _links
        - created_at
        - dimensions
        - dynamic_pricing
        - images
        - live_prices
        - name
        - promotion
        - require_insurance_coverage
        - require_security_deposit
        - security_deposit
        - selling_points
        - size_description
        - slug
        - status
        - stripe_product_id
        - updated_at
      properties:
        id:
          type: string
          pattern: ^utype_
          description: Unique identifier for the unit type (`utype_…`).
        _links:
          type: object
          additionalProperties:
            type: object
            additionalProperties: false
            properties:
              href:
                type: string
                description: Relative path for API links, relative path for CURIE links.
              method:
                type: string
                description: Available only for API links. Other links use always `get`.
                enum:
                  - get
                  - post
                  - patch
                  - delete
              title:
                type: string
                description: Human-readable label for the link.
              reference:
                type:
                  - string
                  - 'null'
                description: >-
                  OpenAPI reference for API links. Component schema for self
                  links, path operation for action links.
          description: Links related to the resource.
        created_at:
          type: string
          format: date-time
          description: Creation date and time for the unit type.
        dimensions:
          $ref: '#/components/schemas/UnitTypesDimensions'
          description: Dimensions of the unit type.
        dynamic_pricing:
          type: boolean
          description: Indicates whether dynamic pricing is enabled for this unit type.
        images:
          type: object
          additionalProperties: false
          properties:
            default:
              type:
                - object
                - 'null'
              description: The `default` image, or `null` when none is uploaded.
              additionalProperties: false
              properties:
                original:
                  type: string
                  format: uri
                  description: Original unresized image.
                small:
                  type: string
                  format: uri
                  description: Resized to max 250x250px.
                medium:
                  type: string
                  format: uri
                  description: Resized to max 500x500px.
                large:
                  type: string
                  format: uri
                  description: Resized to max 1000x1000px.
          description: >-
            Image URLs keyed by image name. Each URL redirects to a short-lived
            download link, so don't cache the redirect target.
        live_prices:
          type: array
          items:
            $ref: '#/components/schemas/Price'
          description: >-
            Current source price used by storefront pricing. Returns the active
            dynamic price when one applies; otherwise returns the base
            storefront price. Promotions, discounts, and tax-exclusive variants
            are not applied.
        name:
          type: string
          description: Name of the unit type.
        promotion:
          anyOf:
            - $ref: '#/components/schemas/Coupon'
            - $ref: '#/components/schemas/CouponCollapsed'
            - type: 'null'
          description: >-
            Promotional coupon associated with the unit type. **Expandable**
            (shows only ID when not expanded).
        require_insurance_coverage:
          type: boolean
          description: Indicates whether insurance coverage is required for this unit type.
        require_security_deposit:
          type: boolean
          description: Indicates whether a security deposit is required for this unit type.
        security_deposit:
          anyOf:
            - $ref: '#/components/schemas/Money'
            - type: 'null'
          description: Security deposit amount for the unit type.
        selling_points:
          type: array
          items:
            type: string
          description: List of selling points for the unit type.
        size_description:
          type: string
          description: Description of the size of the unit type.
        slug:
          type: string
          description: >-
            URL-friendly identifier for the unit type, typically used in web
            addresses.
        status:
          type: string
          enum:
            - bookable
            - hidden
            - lead_capture
          description: >-
            Availability of the unit type on the storefront: `bookable`,
            `lead_capture` (collecting leads) or `hidden`.
        stripe_product_id:
          type:
            - string
            - 'null'
          deprecated: true
          description: >-
            **Deprecated — will be removed in a future API version.** Stripe
            Product ID associated with the unit type, used for payment
            processing. Retained for backwards compatibility; do not use in new
            integrations.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time for the unit type.
      additionalProperties: false
    UnitTypeCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^utype_
          description: Unique identifier for the unit type (`utype_…`).
      additionalProperties: false
    ProtectionLevelExpandableWithoutPrices:
      type: object
      description: Protection Level
      required:
        - id
        - account_code
        - cover_level
        - created_at
        - public
        - site
        - stripe_product_id
        - updated_at
      properties:
        id:
          type: string
          pattern: ^plvl_
          description: Unique identifier for the protection level (`plvl_…`).
        account_code:
          type:
            - string
            - 'null'
          description: Account code associated with the protection level.
        cover_level:
          $ref: '#/components/schemas/Money'
          description: Monetary value representing the cover level of the protection.
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the protection level.
        public:
          type: boolean
          description: Indicates whether the protection level is available for selection.
        site:
          anyOf:
            - $ref: '#/components/schemas/Site'
            - $ref: '#/components/schemas/SiteCollapsed'
            - type: 'null'
          description: >-
            Site associated with the protection level. Returns `null` for global
            protection levels. **Expandable** (shows only ID when not expanded).
        stripe_product_id:
          type:
            - string
            - 'null'
          deprecated: true
          description: >-
            **Deprecated — will be removed in a future API version.** Stripe
            Product ID associated with the protection level, used for payment
            processing. Retained for backwards compatibility; do not use in new
            integrations.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the protection level.
      additionalProperties: false
    ProtectionLevelCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^plvl_
          description: Unique identifier for the protection level (`plvl_…`).
      additionalProperties: false
    SitesAccessHours:
      type: object
      description: Access hours for the site.
      required:
        - friday
        - monday
        - saturday
        - sunday
        - thursday
        - tuesday
        - wednesday
      properties:
        friday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
        monday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
        saturday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
        sunday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
        thursday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
        tuesday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
        wednesday:
          $ref: '#/components/schemas/SiteAccessHoursDay'
      additionalProperties: false
    SitesAddress:
      type: object
      description: Address of the site.
      required:
        - city
        - line_1
        - line_2
        - postal_code
      properties:
        city:
          type:
            - string
            - 'null'
          description: City of the site.
        line_1:
          type:
            - string
            - 'null'
          description: First line of the address.
        line_2:
          type:
            - string
            - 'null'
          description: Second line of the address (optional).
        postal_code:
          type:
            - string
            - 'null'
          description: Postal code of the site.
      additionalProperties: false
    SitesDirections:
      type: object
      description: Directions to the site.
      required:
        - google_maps_url
      properties:
        google_maps_url:
          type:
            - string
            - 'null'
          description: URL to Google Maps for the site.
      additionalProperties: false
    UnitTypesDimensions:
      type: object
      description: Dimensions of the unit type.
      required:
        - height
        - length
        - measurement_unit
        - width
      properties:
        height:
          type: number
          description: Height of the unit type, in `measurement_unit`.
        length:
          type: number
          description: Length of the unit type, in `measurement_unit`.
        measurement_unit:
          type: string
          enum:
            - ft
            - m
          description: 'Unit of length of the dimensions: `m` for metres or `ft` for feet.'
        width:
          type: number
          description: Width of the unit type, in `measurement_unit`.
      additionalProperties: false
    Price:
      type: object
      description: Price
      required:
        - billing_period
        - price
        - stripe_price_id
      properties:
        billing_period:
          type: string
          enum:
            - monthly
            - weekly
            - every_four_weeks
            - every_three_months
            - every_six_months
            - yearly
            - one_time
          description: Billing period for the price.
        price:
          $ref: '#/components/schemas/Money'
          description: Price for the specified billing period.
        stripe_price_id:
          type:
            - string
            - 'null'
          deprecated: true
          description: >-
            **Deprecated — will be removed in a future API version.** Stripe
            Price ID associated with this price, used for payment processing.
            Retained for backwards compatibility; do not use in new
            integrations.
      additionalProperties: false
    Coupon:
      type: object
      description: Coupon
      required:
        - id
        - auto_apply_to
        - billing_period
        - code
        - created_at
        - duration
        - max_redemptions
        - months
        - name
        - public
        - title
        - type
        - updated_at
      properties:
        id:
          type: string
          pattern: ^cpn_
          description: Unique identifier for the coupon (`cpn_…`).
        amount:
          $ref: '#/components/schemas/Money'
          description: Amount deducted from the price when the coupon is applied.
        auto_apply_to:
          $ref: '#/components/schemas/CouponAutoApplyTo'
          description: >-
            Line items the coupon is applied to automatically when used on an
            order.
        billing_period:
          type:
            - string
            - 'null'
          enum:
            - monthly
            - weekly
            - every_four_weeks
            - every_three_months
            - every_six_months
            - yearly
            - one_time
            - null
          description: Used for `repeating` duration.
        code:
          type:
            - string
            - 'null'
          description: Unique code for the coupon for non-public coupons.
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the coupon.
        duration:
          type: string
          enum:
            - once
            - forever
            - repeating
          description: Duration of the coupon.
        max_redemptions:
          type:
            - integer
            - 'null'
          description: Maximum number of times the coupon can be redeemed.
        months:
          type:
            - integer
            - 'null'
          description: >-
            Number of months the coupon is valid for, applicable for `repeating`
            duration.
        name:
          type: string
          description: Name of the coupon.
        percent:
          type: number
          description: >-
            Percentage off the price, greater than 0 and at most 100, with up to
            2 decimal places. `20` means 20% off.
        public:
          type: boolean
          description: >-
            Indicates if the coupon is publicly available for any contact to
            use. When set to `true`, the `code` field is not used.
        title:
          type:
            - string
            - 'null'
          description: Title of the coupon.
        type:
          type: string
          enum:
            - percentage
            - amount
          description: Type of the coupon.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the coupon.
      additionalProperties: false
    CouponCollapsed:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^cpn_
          description: Unique identifier for the coupon (`cpn_…`).
      additionalProperties: false
    Money:
      type: object
      description: Money
      required:
        - amount
        - currency
        - formatted
      properties:
        amount:
          type: integer
          description: Amount of money in the smallest currency unit (e.g., cents for USD).
        currency:
          type: string
          enum:
            - AED
            - AUD
            - BGN
            - BRL
            - CAD
            - CHF
            - CZK
            - DKK
            - EUR
            - GBP
            - HKD
            - HUF
            - MXN
            - MYR
            - NOK
            - NZD
            - PLN
            - RON
            - SEK
            - SGD
            - THB
            - USD
          description: ISO 4217 currency code.
        formatted:
          type: string
          description: >-
            Formatted string representation of the money amount, including the
            currency symbol.
      additionalProperties: false
    SiteAccessHoursDay:
      type: object
      description: Access Hours Day
      required:
        - close
        - open
        - status
      properties:
        close:
          type:
            - string
            - 'null'
          description: >-
            Closing time in 24-hour `HH:MM` format. Has `null` for `appointment`
            or `closed` status.
        open:
          type:
            - string
            - 'null'
          description: >-
            Opening time in 24-hour `HH:MM` format. Has `null` for `appointment`
            or `closed` status.
        status:
          type: string
          enum:
            - set_hours
            - appointment
            - closed
          description: >-
            Access on the day: `set_hours` between `open` and `close`,
            `appointment` by appointment only, or `closed`.
      additionalProperties: false
    CouponAutoApplyTo:
      type: object
      description: Defines how the coupon should be auto-applied when used on an order.
      required:
        - products
        - protections
        - subscriptions
        - unit_types
      properties:
        products:
          type: boolean
          description: Whether the coupon applies to product line items.
        protections:
          type: boolean
          description: Whether the coupon applies to protection line items.
        subscriptions:
          type: boolean
          description: Whether the coupon applies to the subscription.
        unit_types:
          type: boolean
          description: Whether the coupon applies to unit type line items.
      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.