FreshBooks Clients API

The Clients API from FreshBooks — 2 operation(s) for clients.

OpenAPI Specification

freshbooks-clients-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: FreshBooks REST Auth Clients API
  version: '2026-05-23'
  description: 'Best-effort OpenAPI 3.1 description of the FreshBooks accounting REST API.

    Scoped per account via /accounting/account/{accountId}/* paths.

    Generated from public documentation; not an official spec.

    '
  contact:
    name: FreshBooks Developer Portal
    url: https://www.freshbooks.com/api/start
servers:
- url: https://api.freshbooks.com
  description: Production
security:
- bearerAuth: []
tags:
- name: Clients
paths:
  /accounting/account/{accountId}/users/clients:
    parameters:
    - $ref: '#/components/parameters/AccountId'
    get:
      tags:
      - Clients
      operationId: listClients
      responses:
        '200':
          $ref: '#/components/responses/Ok'
    post:
      tags:
      - Clients
      operationId: createClient
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Object'
      responses:
        '200':
          $ref: '#/components/responses/Ok'
  /accounting/account/{accountId}/users/clients/{clientId}:
    parameters:
    - $ref: '#/components/parameters/AccountId'
    - in: path
      name: clientId
      required: true
      schema:
        type: string
    get:
      tags:
      - Clients
      operationId: getClient
      responses:
        '200':
          $ref: '#/components/responses/Ok'
    put:
      tags:
      - Clients
      operationId: updateClient
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Object'
      responses:
        '200':
          $ref: '#/components/responses/Ok'
components:
  schemas:
    Object:
      type: object
      additionalProperties: true
  responses:
    Ok:
      description: Successful response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Object'
  parameters:
    AccountId:
      in: path
      name: accountId
      required: true
      schema:
        type: string
      description: FreshBooks account identifier (business account id)
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 access token obtained via the FreshBooks authorization code flow.