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

# List Pricelists



## OpenAPI

````yaml /openapi/public.openapi.json get /v1/pricelists
openapi: 3.1.0
info:
  title: CurbWaste Public API
  version: 1.0.0
  description: >-
    Partner-facing public API under /v1. Authenticate with a company API key
    (Authorization: Bearer cw_live_…). Outbound webhooks (customer.created /
    customer.updated / location.created / location.updated / pricelist.created)
    use HMAC and are documented separately.
  contact:
    name: CurbWaste
  license:
    name: UNLICENSED 1
servers:
  - url: https://api.curbwaste.com
    description: Production public API
security:
  - ApiKeyBearer: []
tags:
  - name: Customers
    description: >-
      Company CRM customers under /v1/customers. Requires customers:read or
      customers:write.
  - name: Catalog
  - name: Locations
  - name: Zones
paths:
  /v1/pricelists:
    get:
      tags:
        - Catalog
      summary: List Pricelists
      operationId: listPricelists
      parameters:
        - name: q
          in: query
          schema:
            type: string
            maxLength: 255
          required: false
        - name: scope
          in: query
          schema:
            type: string
            maxLength: 32
          required: false
        - name: customerId
          in: query
          schema:
            type: string
            format: uuid
          required: false
        - name: serviceId
          in: query
          schema:
            type: string
            format: uuid
          required: false
        - name: isDefault
          in: query
          schema:
            type: boolean
          required: false
        - name: isEcommerce
          in: query
          schema:
            type: boolean
          required: false
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
          required: false
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
          required: false
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicCatalogListResponsePublicPricelist'
components:
  schemas:
    PublicCatalogListResponsePublicPricelist:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PublicPricelist'
        page:
          type: number
        limit:
          type: number
        total:
          type: number
      required:
        - data
        - page
        - limit
        - total
    PublicPricelist:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        scope:
          oneOf:
            - type: 'null'
            - type: string
        status:
          oneOf:
            - type: 'null'
            - type: string
        isDefault:
          type: boolean
        isEcommerce:
          type: boolean
        isZoneBased:
          type: boolean
        services:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              identifier:
                oneOf:
                  - type: 'null'
                  - type: string
            required:
              - id
              - identifier
        skuCount:
          type: number
        chargeCount:
          type: number
        customerCount:
          type: number
      required:
        - id
        - name
        - scope
        - status
        - isDefault
        - isEcommerce
        - isZoneBased
        - services
        - skuCount
        - chargeCount
        - customerCount
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Company API key from the developer platform. Header: Authorization:
        Bearer cw_live_…. Key must include customers:read and/or
        customers:write.

````

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