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

# Page accounts

> Customers with complete contact/location associations, tags, and recorded acquisition sources. Orders by created_at then id ascending. Complete embedded relationships are returned on every page.



## OpenAPI

````yaml /openapi.json get /accounts
openapi: 3.0.3
info:
  title: Breezy Public Reporting API
  version: 1.0.0
  description: >-
    Read customers, team members, jobs, visits, assignments, installed
    equipment, captured form responses, time entries, configured-period
    timesheets, business reference catalogs, job leads, estimates, invoices,
    payments, refunds, recorded job financials, saved sold/earned credits, and
    financial summaries for your company. Existing API keys grant company-wide
    read access. Amounts are integer USD cents. Reads return current corrected
    records, with cursor pagination for collecting results.


    Read the [Breezy FSM guides](https://developers.getbreezyapp.com) for
    authentication, pagination, refresh limits, and business measures. All reads
    use latest corrected company records; cursors do not create a snapshot or a
    complete change feed.
servers:
  - url: https://api.getbreezyapp.com/v1
    description: Breezy FSM production API
security:
  - apiKey: []
tags:
  - name: Company
  - name: Invoices
  - name: Payments
  - name: Refunds
  - name: Reports
  - name: TeamMembers
  - name: Accounts
  - name: Contacts
  - name: Locations
  - name: Jobs
  - name: JobAppointments
  - name: JobAssignments
  - name: BusinessUnits
  - name: JobTypes
  - name: JobClasses
  - name: JobLifecycles
  - name: LeadSources
  - name: Tags
  - name: Estimates
  - name: JobLeads
  - name: Equipment
  - name: FormResponses
  - name: TimeEntries
  - name: Timesheets
  - name: JobFinancials
  - name: RevenueAttributions
externalDocs:
  description: Breezy FSM reporting guides and API reference
  url: https://developers.getbreezyapp.com
paths:
  /accounts:
    get:
      tags:
        - Accounts
      summary: Page accounts
      description: >-
        Customers with complete contact/location associations, tags, and
        recorded acquisition sources. Orders by created_at then id ascending.
        Complete embedded relationships are returned on every page.
      operationId: listAccounts
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
            description: >-
              Maximum parent records or report rows. Complete children are
              always included.
          required: false
          description: >-
            Maximum parent records or report rows. Complete children are always
            included.
          name: limit
          in: query
        - schema:
            type: string
            nullable: true
            minLength: 1
            default: null
            description: >-
              Repeat the original filters; any valid page size may continue.
              Foreign-company, tampered or mismatched cursors return
              INVALID_CURSOR.
          required: false
          description: >-
            Repeat the original filters; any valid page size may continue.
            Foreign-company, tampered or mismatched cursors return
            INVALID_CURSOR.
          name: cursor
          in: query
        - schema:
            type: array
            nullable: true
            items:
              type: string
              format: uuid
            minItems: 1
            maxItems: 100
            default: null
            description: >-
              Repeat ids for a bounded ID set. Valid foreign or missing IDs
              contribute no list rows.
          required: false
          style: form
          explode: true
          name: ids
          in: query
        - schema:
            type: string
            nullable: true
            format: date-time
            default: null
            description: Inclusive creation instant.
          required: false
          description: Inclusive creation instant.
          name: created_from
          in: query
        - schema:
            type: string
            nullable: true
            format: date-time
            default: null
            description: Exclusive creation instant.
          required: false
          description: Exclusive creation instant.
          name: created_before
          in: query
        - schema:
            type: string
            nullable: true
            format: date-time
            default: null
            description: >-
              Inclusive parent-record updated_at filter only; not a complete
              change feed.
          required: false
          description: >-
            Inclusive parent-record updated_at filter only; not a complete
            change feed.
          name: updated_since
          in: query
        - schema:
            type: string
            nullable: true
            enum:
              - RESIDENTIAL
              - COMMERCIAL
              - null
          required: false
          name: type
          in: query
        - schema:
            type: boolean
            nullable: true
            default: null
          required: false
          name: archived
          in: query
        - schema:
            type: string
            nullable: true
            format: uuid
            default: null
          required: false
          name: contact_id
          in: query
        - schema:
            type: string
            nullable: true
            format: uuid
            default: null
          required: false
          name: location_id
          in: query
      responses:
        '200':
          description: Successful read. Clients ignore unrecognized response fields.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountPage'
              example:
                data:
                  - id: 11111111-1111-4111-8111-000000000101
                    name: Example Household
                    number: '100'
                    customer_since: '2018-03-10T23:59:59.123456Z'
                    type: RESIDENTIAL
                    archived: false
                    do_not_service: false
                    do_not_service_reason: null
                    account_manager: null
                    mailing_address:
                      id: 11111111-1111-4111-8111-000000001104
                      formatted: 123 Example Lane, Los Angeles, CA 90001
                      line_1: 123 Example Lane
                      line_2: null
                      city: Los Angeles
                      state: CA
                      postal_code: '90001'
                    contacts:
                      - id: 11111111-1111-4111-8111-000000001108
                        contact:
                          id: 11111111-1111-4111-8111-000000001101
                          name: Jordan Example
                        is_primary: true
                        archived: false
                    locations:
                      - location_id: 11111111-1111-4111-8111-000000001107
                        archived: false
                    tags:
                      - id: 11111111-1111-4111-8111-000000001106
                        name: Priority customer
                    lead_sources:
                      - id: 11111111-1111-4111-8111-000000001105
                        name: Referral
                    created_at: '2026-08-19T16:00:00Z'
                    updated_at: '2026-09-08T19:00:00Z'
                pagination:
                  next_cursor: null
                meta:
                  request_id: 11111111-1111-4111-8111-000000009999
                  generated_at: '2026-09-08T19:00:00Z'
                  timezone: America/Los_Angeles
        '400':
          description: >-
            Malformed input, unknown query parameter, unsupported combination or
            invalid cursor.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: INVALID_REQUEST
                  message: end_date must be later than start_date
                  request_id: example-request
                  details: []
        '401':
          description: Missing, invalid or expired key, or invalid linked identity.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
            WWW-Authenticate:
              schema:
                type: string
              example: Bearer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: UNAUTHENTICATED
                  message: A valid API key is required
                  request_id: example-request
                  details: []
        '404':
          description: >-
            Missing resource or resource outside the authenticated company. Same
            response for both.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: NOT_FOUND
                  message: Resource not found
                  request_id: example-request
                  details: []
        '405':
          description: Write methods do not mutate business data and return 405.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
            Allow:
              schema:
                type: string
              example: GET, HEAD, OPTIONS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: METHOD_NOT_ALLOWED
                  message: This resource supports GET
                  request_id: example-request
                  details: []
        '429':
          description: Company request budget exhausted; retry after the indicated delay.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
            Retry-After:
              schema:
                type: integer
                minimum: 1
              description: Seconds before retrying.
              example: 30
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: RATE_LIMITED
                  message: Request limit exceeded
                  request_id: example-request
                  details: []
        '500':
          description: >-
            Unexpected failure. Share request_id with support; no stack or
            provider secrets in response.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: INTERNAL_ERROR
                  message: Unable to complete request
                  request_id: example-request
                  details: []
      security:
        - apiKey: []
components:
  schemas:
    AccountPage:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Account'
        pagination:
          $ref: '#/components/schemas/Pagination'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      required:
        - data
        - pagination
        - meta
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - INVALID_REQUEST
                - INVALID_CURSOR
                - UNAUTHENTICATED
                - NOT_FOUND
                - METHOD_NOT_ALLOWED
                - RATE_LIMITED
                - INTERNAL_ERROR
            message:
              type: string
            request_id:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - field
                  - message
          required:
            - code
            - message
            - request_id
            - details
      required:
        - error
    Account:
      type: object
      properties:
        id:
          type: string
          format: uuid
        number:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
            - RESIDENTIAL
            - COMMERCIAL
        customer_since:
          type: string
          format: date-time
          description: >-
            Recorded customer-since time, which can predate technical creation
            after an import.
        archived:
          type: boolean
        do_not_service:
          type: boolean
        do_not_service_reason:
          type: string
          nullable: true
        account_manager:
          $ref: '#/components/schemas/NullableReference'
        mailing_address:
          type: object
          nullable: true
          properties:
            id:
              type: string
              format: uuid
            formatted:
              type: string
            line_1:
              type: string
            line_2:
              type: string
              nullable: true
            city:
              type: string
            state:
              type: string
            postal_code:
              type: string
          required:
            - id
            - formatted
            - line_1
            - line_2
            - city
            - state
            - postal_code
        contacts:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              contact:
                $ref: '#/components/schemas/Reference'
              is_primary:
                type: boolean
              archived:
                type: boolean
            required:
              - id
              - contact
              - is_primary
              - archived
        locations:
          type: array
          items:
            type: object
            properties:
              location_id:
                type: string
                format: uuid
              archived:
                type: boolean
            required:
              - location_id
              - archived
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Reference'
        lead_sources:
          type: array
          items:
            $ref: '#/components/schemas/Reference'
          description: Recorded account acquisition sources; separate from job sources.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
          description: >-
            Parent record edit time only; related records may change
            independently.
      required:
        - id
        - number
        - name
        - type
        - customer_since
        - archived
        - do_not_service
        - do_not_service_reason
        - account_manager
        - mailing_address
        - contacts
        - locations
        - tags
        - lead_sources
        - created_at
        - updated_at
    Pagination:
      type: object
      properties:
        next_cursor:
          type: string
          nullable: true
          description: >-
            Opaque continuation. Null ends traversal. Keep the same filters;
            page size may change.
      required:
        - next_cursor
    ResponseMeta:
      type: object
      properties:
        request_id:
          type: string
        generated_at:
          type: string
          format: date-time
        timezone:
          type: string
      required:
        - request_id
        - generated_at
        - timezone
      description: >-
        Generation time and company timezone. generated_at is not a snapshot or
        synchronization token.
    NullableReference:
      type: object
      nullable: true
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
      required:
        - id
        - name
    Reference:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
      required:
        - id
        - name
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Existing Breezy API key. Grants all published reads in its associated
        company. No app permission scopes.

````