Housecall Pro Companies API

The Companies API from Housecall Pro — 1 operation(s) for companies.

OpenAPI Specification

housecall-pro-companies-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Housecall Pro Public Companies API
  version: '1.0'
  description: 'The Housecall Pro Public API exposes core resources of the Housecall Pro home services

    business management platform — customers, leads, jobs, estimates, invoices, payments,

    employees, schedule items, line items, and webhooks. The API is available to Pros on

    the MAX plan and is documented on Stoplight at https://docs.housecallpro.com/.

    '
  contact:
    name: Housecall Pro
    url: https://www.housecallpro.com
  license:
    name: Proprietary
servers:
- url: https://api.housecallpro.com
  description: Production
security:
- bearerAuth: []
- apiKey: []
tags:
- name: Companies
paths:
  /companies:
    get:
      tags:
      - Companies
      summary: List Companies
      operationId: listCompanies
      responses:
        '200':
          description: Company collection.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: Bearer token using the API key generated from the MAX-plan App Store API card.
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: 'API key passed as `Authorization: Token {key}`.'