> ## 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 all equipment packages for the authenticated organization

> Returns a paginated list of equipment packages (onboarding bundles) belonging to the caller's organization. Each package contains SKUs and rules that determine what equipment new joiners receive automatically.



## OpenAPI

````yaml /openapi.json get /api/v1/packages
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: Inventory Orders
    description: Create and manage inventory orders
  - name: Shipment Notices V1
    description: 'Query shipment notice orders (V1: package items expose `inventories` list)'
  - name: Packages
    description: ''
  - name: Categories
    description: Query available categories for asset creation
  - name: Catalog
    description: ''
  - name: New Joiners
    description: New joiner provisioning pipeline for the organization
  - name: Orders
    description: ''
  - name: People
    description: >-
      Manage the users of Firstbase for your organization. API follows the SCIM
      standard.
    externalDocs:
      url: https://scim.cloud/
  - name: People — Lifecycle
    description: Offboard and reactivate users.
  - name: Assets
    description: Manage inventory assets
  - name: Regions V1
    description: Query regions (V1)
  - name: Warehouses V1
    description: Query warehouses (V1)
  - name: Brands
    description: Query available brands for asset creation
  - name: Inventory
    description: ''
  - name: Replacements
    description: Create and manage equipment replacements
  - name: Offices
    description: Manage and query office locations for the authenticated organization
  - name: Returns
    description: Return and Replacements
paths:
  /api/v1/packages:
    get:
      tags:
        - Packages
      summary: List all equipment packages for the authenticated organization
      description: >-
        Returns a paginated list of equipment packages (onboarding bundles)
        belonging to the caller's organization. Each package contains SKUs and
        rules that determine what equipment new joiners receive automatically.
      operationId: listPackages
      parameters:
        - name: page
          in: query
          description: Zero-based page index (0..N)
          required: false
          schema:
            type: integer
            default: 0
            minimum: 0
        - name: size
          in: query
          description: The size of the page to be returned
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
        - name: sort
          in: query
          description: >-
            Sorting criteria in the format: property,(asc|desc). Default sort
            order is ascending. Multiple sort criteria are supported.
          required: false
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Paginated list of packages
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Package'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
        '403':
          description: Forbidden
          content:
            '*/*':
              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:
    Package:
      type: object
      description: >-
        An equipment package (onboarding bundle) that can be assigned to a
        person
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for this package
          example: 3a68a467-8733-4c8d-a942-16ed7ec33018
        name:
          type: string
          description: Display name of the package
          example: The works
        automaticOrder:
          type: boolean
          description: >-
            When true, an equipment order is placed automatically when a person
            with this package is onboarded
          example: false
        approvalRequired:
          type: boolean
          description: >-
            When true, orders from this package require manager approval before
            being processed
          example: false
        requireJustification:
          type: boolean
          description: When true, order items in this package require a justification
          example: false
        active:
          type: boolean
          description: >-
            Whether this package is currently active. Inactive packages cannot
            be used for new assignments
          example: true
        skuIds:
          type: array
          description: >-
            List of SKU IDs included in this package; null when no SKUs are
            configured
          examples:
            - 3cf416c1-1b0f-4344-9cec-ba9c9fe615c9
          items:
            type: string
            format: uuid
        assignedTo:
          $ref: '#/components/schemas/PackageAssignedToInformation'
          description: People and groups currently assigned to this package
      required:
        - active
        - approvalRequired
        - assignedTo
        - automaticOrder
        - id
        - name
        - requireJustification
    PublicApiHttpErrors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiError'
      required:
        - errors
    PackageAssignedToInformation:
      type: object
      properties:
        people:
          type: array
          description: >-
            List of people assigned to this package. Each entry contains
            identifying information for a person linked to this package
            assignment.
          examples:
            - 3cf416c1-1b0f-4344-9cec-ba9c9fe615c9
          items:
            type: string
            format: uuid
    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

````