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

# List Contacts API

> Retrieve Breezing contacts with cursor pagination and search by name or address to label crypto counterparties in accounting workflows.



## OpenAPI

````yaml GET /contacts
openapi: 3.1.0
info:
  title: Breezing Public API
  version: 1.0.0
  description: >-
    Crypto accounting API for programmatic access and AI agents. Authenticate
    with an API key using the Authorization header: `Bearer brz_...`
servers:
  - url: https://api.breezing.io/v1
security:
  - BearerAuth: []
paths:
  /contacts:
    get:
      tags:
        - Contacts
      summary: List contacts
      description: >-
        List contacts (named counterparty addresses) for the company, with
        cursor-based pagination and optional search.


        Contacts are how Breezing turns raw addresses into human-readable
        counterparties. They appear as walletFromName / walletToName on every
        transaction the address is involved in. Naming a contact like "0x..." →
        "Coinbase Hot Wallet" gives every related transaction immediate context
        for categorization.


        Default: 50 per page, ordered by id descending (newest first). Use
        search to find by name or address prefix.
      parameters:
        - schema:
            type: string
            description: >-
              Organization ID. Use GET /v1/companies to discover available
              org/company pairs.
            example: '1'
          required: true
          description: >-
            Organization ID. Use GET /v1/companies to discover available
            org/company pairs.
          name: orgId
          in: query
        - schema:
            type: string
            description: >-
              Company ID. Use GET /v1/companies to discover available companies
              and their access levels.
            example: '1'
          required: true
          description: >-
            Company ID. Use GET /v1/companies to discover available companies
            and their access levels.
          name: companyId
          in: query
        - schema:
            type: string
            description: >-
              Contact ID to start after (cursor-based pagination, ordered by id
              desc).
            example: '100'
          required: false
          description: >-
            Contact ID to start after (cursor-based pagination, ordered by id
            desc).
          name: cursor
          in: query
        - schema:
            type: string
            default: '50'
            description: Number of contacts to return (1-100, default 50)
            example: '50'
          required: false
          description: Number of contacts to return (1-100, default 50)
          name: limit
          in: query
        - schema:
            type: string
            description: >-
              Search by name (substring match) or address (prefix match,
              case-insensitive).
            example: binance
          required: false
          description: >-
            Search by name (substring match) or address (prefix match,
            case-insensitive).
          name: search
          in: query
      responses:
        '200':
          description: Contacts retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contact'
                  pagination:
                    type: object
                    properties:
                      limit:
                        type: integer
                      cursor:
                        type: integer
                        nullable: true
                      hasMore:
                        type: boolean
                    required:
                      - limit
                      - cursor
                      - hasMore
                required:
                  - success
                  - data
                  - pagination
        '400':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '403':
          description: >-
            API key has no access to this company, has read-only access where
            write was required, or the company subscription is inactive
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
      security:
        - BearerAuth: []
components:
  schemas:
    Contact:
      type: object
      properties:
        id:
          type: number
          description: Contact ID
        name:
          type: string
          nullable: true
          description: Display name (e.g. "Binance Hot Wallet")
        address:
          type: string
          description: Wallet/account address
        chain:
          type: string
          nullable: true
          description: Chain identifier (optional, e.g. "eth", "btc")
        qboEntity:
          type: string
          nullable: true
          description: >-
            QuickBooks entity reference for sync (optional). Set this to map the
            contact to a QuickBooks customer/vendor.
        orgId:
          type: number
          description: Organization ID
        companyId:
          type: number
          description: Company ID
        createdAt:
          type: number
          description: Created timestamp (unix ms)
        updatedAt:
          type: number
          description: Updated timestamp (unix ms)
      required:
        - id
        - name
        - address
        - chain
        - qboEntity
        - orgId
        - companyId
        - createdAt
        - updatedAt

````