> ## 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. # List all Sites > Retrieve a list of all sites. Required authorization scope: `public.site:read` ## OpenAPI ````yaml /2025-09/openapi.json get /2025-09/sites openapi: 3.1.1 info: title: Stora Public API version: 2025-09 x-build-date: '2026-05-20' 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 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 that inquires, books, signs agreements, and pays for storage. - name: Contract Templates description: >- Contract Template is a reusable contract blueprint. It contains the contract content with fillable fields and variables that Stora can pre‑fill at document generation time for a specific contact and tenancy. - name: Contracts description: >- Contract is a document generated from a contract template for a specific contact. It tracks the signing lifecycle, moving through statuses such as pending, signed, voided, declined, and deleted. - name: Coupons description: >- Coupon is a reusable promotion that reduces 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 product and may be limited by duration, number of uses, or scope. - name: Credit Notes description: >- Credit Note reduces or reverses part or all of a previously issued invoice. It references the original invoice and contact, along with the specified corrected amounts and taxes. - name: Deals description: >- Deal refers to the collection of information pertaining to a potential order including contact, site, unit types, protection. - name: Deals / Stages description: Deal Stage refers to the stages a deal transitions through. - name: Identity Verifications description: Identity Verification tracks the process of verifying a contacts identity. - name: Images description: >- Serves images associated with resources such as sites and unit types. 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 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: >- A note is a text annotation attached to a resource such as a contact, unit, subscription, or task. Notes capture observations, reminders, or context added by staff or integrations. - name: OAuth 2 description: >- The Stora Public API supports two OAuth 2.0 flows. Use **Client Credentials** if you are an operator building your own integration. Use **Authorization Code** if you are a partner integrating on behalf of an operator. - name: Orders description: >- Order captures a contact’s intent to rent storage, including the selected site and unit type, move‑in date, pricing, and optional add‑ons like protection, products, and services. It tracks status over its lifecycle, and may lead to a subscription that bills on a recurring basis. - name: Orders / Line Items description: >- Order Line Items are the individual charges that make up an order. 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: Product Categories description: >- Product Category groups related products and services into a logical classification used for pricing and display. - name: Products description: >- Product represents a sellable item or service offered by the operator. It defines attributes such as name, description, pricing model, currency, and category, which determine how it’s presented and billed. - name: Protection Levels description: >- Protection Level is an optional add‑on that protects a contact’s stored goods up to a chosen coverage amount. 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. - name: Sites description: >- Site is a single physical self‑storage location operated by the operator. It’s the container for everything specific to that location: units and unit types, pricing and taxes, access control, and reporting. - name: Staff description: >- Staff refers to a member of an organization who works on behalf of the operator. - name: Subscriptions description: >- Subscription is an ongoing billing agreement that charges a contact on a recurring schedule for storage and related services. It defines the billing period and active prices, accrues charges into invoices, and reflects proration, discounts, and taxes. - name: Tasks description: Tasks represent individual pieces of work or actions. - name: Tenancies description: >- Tenancy represents an ongoing storage agreement between a contact and an operator, tied to a site and one or more allocated units. - name: Timeline / Events description: >- An event represents a custom timeline entry created by an external integration, such as a CRM or messaging app. - name: Timeline / Sources description: >- A source represents the origin of a custom timeline event, such as an external CRM, or a custom integration. - name: Timeline / Templates description: >- A template defines the message format for a custom timeline event, including the Liquid template and available variables. - name: Unit Allocations description: >- Unit Allocation represents the assignment of a specific unit to a tenancy, tracking reservation and access details. - name: Unit Types description: >- Unit Type represents a standardized storage offering at a site, such as “50 sq ft indoor” or “20 ft container.” It defines core attributes used for pricing and availability, 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. It carries concrete attributes like identifier and status. - name: Webhook Endpoints description: >- Webhook endpoints are used to receive notifications when specific events occur in Stora. We will send a `POST` request to the endpoint with the event payload. - name: Webhooks description: >- Webhooks are HTTP callbacks that send real-time `POST` requests to your configured endpoints when specific events occur in Stora. When an event happens (such as an invoice being paid or a credit note being created), Stora will immediately send a webhook 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/sites: get: tags: - Sites summary: List all Sites description: | Retrieve a list of all sites. Required authorization scope: `public.site:read` operationId: site_list parameters: - name: page in: query schema: type: integer minimum: 1 description: 'Pagination: Page number' required: false - name: limit in: query schema: type: integer minimum: 1 maximum: 100 description: 'Pagination: Limit number of items per page.' required: false - name: sort_by in: query schema: type: string enum: - created_at - name - updated_at description: Sorting by attribute. Default `created_at` required: false - name: sort_direction in: query schema: type: string enum: - ASC - DESC description: Sorting by `ASC` or `DESC` direction. Default `DESC` required: false - name: search in: query schema: type: string description: Search sites by name (fuzzy match). **BETA** required: false responses: '200': description: list of sites content: application/json: examples: json: value: sites: - id: site_14b419f1096013f1 access_hours: friday: close: '18:00' open: '08:00' status: set_hours monday: close: '18:00' open: '08:00' status: set_hours saturday: close: '18:00' open: '08:00' status: set_hours sunday: close: '18:00' open: '08:00' status: set_hours thursday: close: '18:00' open: '08:00' status: set_hours tuesday: close: '18:00' open: '08:00' status: set_hours wednesday: close: '18:00' open: '08:00' status: set_hours address: city: Segfault Springs line_1: 42 Hitchhiker's Lane line_2: Unit NaN postal_code: NULL00 created_at: '2025-02-20T14:41:00Z' description: A site for all your Stack Overflow needs. directions: google_maps_url: >- https://maps.google.com/?q=Stora+-+Self+Storage+Software images: default: null name: The Stack Overflow Station opened_at: '2025-02-24T14:41:00Z' phone: '012345789' 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 pagination: count: 1 last: 1 limit: 50 next: null page: 1 pages: 1 prev: null summary: list of sites in JSON schema: $ref: '#/components/schemas/site_list' security: - Bearer: - public.site:read - OAuth2: - public.site:read components: schemas: site_list: type: object description: List of Sites additionalProperties: false properties: sites: type: array items: $ref: '#/components/schemas/Site' meta: $ref: '#/components/schemas/MetaWithPagination' Site: type: object description: Site additionalProperties: false properties: id: type: string description: Unique identifier for the site. name: type: string description: Name of the site. description: type: - string - 'null' description: Description of the site. created_at: type: string format: date-time description: Creation date and time of the site. updated_at: type: string format: date-time description: Last update date and time of the site. phone: type: - string - 'null' description: Phone number of the site. opened_at: type: - string - 'null' format: date-time description: Date and time when the site was/will be opened. directions: type: - object - 'null' description: Directions to the site. additionalProperties: false properties: google_maps_url: type: - string - 'null' description: URL to Google Maps for the site. images: type: object additionalProperties: false properties: default: type: - object - 'null' 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. access_hours: type: - object - 'null' description: Access hours for the site. additionalProperties: false properties: monday: $ref: '#/components/schemas/SiteAccessHoursDay' tuesday: $ref: '#/components/schemas/SiteAccessHoursDay' wednesday: $ref: '#/components/schemas/SiteAccessHoursDay' thursday: $ref: '#/components/schemas/SiteAccessHoursDay' friday: $ref: '#/components/schemas/SiteAccessHoursDay' saturday: $ref: '#/components/schemas/SiteAccessHoursDay' sunday: $ref: '#/components/schemas/SiteAccessHoursDay' address: type: - object - 'null' description: Address of the site. additionalProperties: false properties: line_1: type: - string - 'null' description: First line of the address. line_2: type: - string - 'null' description: Second line of the address (optional). city: type: - string - 'null' description: City of the site. postal_code: type: - string - 'null' description: Postal code of the site. MetaWithPagination: allOf: - type: object properties: pagination: $ref: '#/components/schemas/Pagination' - $ref: '#/components/schemas/Meta' SiteAccessHoursDay: type: object description: Access Hours Day additionalProperties: false properties: status: enum: - set_hours - appointment - closed type: string open: type: - string - 'null' description: >- Opening time in HH:MM format. Has `null` for `appointment` or `closed` status. close: type: - string - 'null' description: >- Closing time in HH:MM format. Has `null` for `appointment` or `closed` status. Pagination: type: object description: Pagination additionalProperties: false properties: count: type: - integer - 'null' description: >- Total number of items. The `null` value is used with countless pagination (used for faster response on large datasets). last: type: - integer - 'null' description: Last page number. limit: type: integer description: Number of items per page. next: type: - integer - 'null' page: type: integer description: Current page. pages: type: integer description: Total number of pages. prev: type: - integer - 'null' Meta: type: object properties: request_id: type: string description: Unique request identifier. curies: type: array description: CURIE definitions for resolving namespaced link relations. items: $ref: '#/components/schemas/Curie' Curie: type: object description: CURIE definition for resolving namespaced link relations. additionalProperties: false properties: name: type: string description: CURIE prefix name enum: - bo - sf href: type: string description: URI template for resolving the CURIE. templated: type: boolean description: Whether the href is a URI template. title: type: string description: Human-readable title. 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: /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.order:read: Order (Read) public.order:write: Order (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: /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.order:read: Order (Read) public.order:write: Order (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) ````