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

# List regions

> Returns a paginated list of geographic regions associated with the caller's organization. Regions define where inventory levels apply and where warehouses operate. Optionally filter by region name (partial match) or region code. Page and size are 1-based and capped at 100 per page.



## OpenAPI

````yaml /openapi.json get /api/v1/regions
openapi: 3.1.0
info:
  title: Firstbase API Specification Beta
  description: Integration endpoints for Firstbase
  version: 0.1.0
servers:
  - url: /
    description: Default
security:
  - ApiKey: []
tags:
  - name: Catalog
    description: Browse SKUs, brands, and categories
  - name: Inventory
    description: Query and manage inventory items and assets
  - name: Inventory Levels
    description: Configure inventory levels by SKU and warehouse
  - name: Inventory Orders
    description: Create and manage inventory orders
  - name: ITAD
    description: IT asset disposition requests
  - name: New Joiners
    description: Track and remind new joiners
  - name: Offices
    description: Manage office locations
  - name: Orders
    description: Create and track equipment orders
  - name: Packages
    description: Manage equipment packages
  - name: People
    description: Provision and manage users
  - name: Regions
    description: Query regions
  - name: Replacements
    description: Create and manage equipment replacements
  - name: Returns
    description: Create and manage returns
  - name: Shipment
    description: Look up shipments and carriers
  - name: Shipment Notices
    description: Create and manage shipment notices
  - name: Warehouses
    description: Query warehouses
paths:
  /api/v1/regions:
    get:
      tags:
        - Regions
      summary: List regions
      description: >-
        Returns a paginated list of geographic regions associated with the
        caller's organization. Regions define where inventory levels apply and
        where warehouses operate. Optionally filter by region name (partial
        match) or region code. Page and size are 1-based and capped at 100 per
        page.
      operationId: listRegionsV1
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            format: int32
            default: 1
            minimum: 1
        - name: size
          in: query
          required: false
          schema:
            type: integer
            format: int32
            default: 100
            maximum: 100
            minimum: 1
        - name: name
          in: query
          required: false
          schema:
            type: string
        - name: regionCode
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Paginated list of regions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageDTO'
        '400':
          description: Invalid pagination parameters — page or size out of range
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
        '403':
          description: Endpoint not available for this organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
        '409':
          description: Conflict
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
components:
  schemas:
    PageDTO:
      type: object
      description: >-
        Standard paginated response wrapper used by all list endpoints. Use
        `pageNumber` and `size` to paginate; stop when `pageNumber >=
        totalPages`.
      properties:
        size:
          type: integer
          format: int32
          description: Maximum number of items per page as requested
          example: 10
        totalElements:
          type: integer
          format: int64
          description: Total number of items matching the query across all pages
          example: 42
        totalPages:
          type: integer
          format: int32
          description: Total number of pages based on totalElements / size
          example: 5
        pageNumber:
          type: integer
          format: int32
          description: Current page number, 1-based (first page = 1)
          example: 1
        data:
          type: array
          description: Items in the current page; may be fewer than `size` on the last page
          items: {}
      required:
        - data
        - pageNumber
        - size
        - totalElements
        - totalPages
    PublicApiHttpErrors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiError'
      required:
        - errors
    PublicApiError:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable description of the error
          example: Invalid request
        source:
          type: string
          description: >-
            Entity or field path that caused the error (for example order,
            shipmentNotice, or person:email)
          example: request
      required:
        - detail
        - source
  securitySchemes:
    ApiKey:
      type: apiKey
      description: Prefix the value with "ApiKey" to indicate the custom authorization type
      name: Authorization
      in: header

````