Builder Prime Open API

name: Builder Prime Open API
description: Builder Prime's REST "Open API" — the tenant-scoped integration surface used to create leads
  and clients, and to read clients, employees, projects, appointments, appointment types and appointment
  results. Authenticated with a per-tenant secret key issued from Admin > Integrations > Open API and
  sent in the x-api-key header; each key is granted named permissions (for example clients.create). Resources
  are individually versioned in the path (/api/<resource>/v1). Builder Prime publishes no OpenAPI definition
  and, as of this probe, no longer publishes a public endpoint reference.
humanURL: https://www.builderprime.com/blog/open-api-documentation
baseURL: https://app.builderprime.com
x-base-url-pattern: https://{subdomain}.builderprime.com
x-base-url-note: Builder Prime documents a per-tenant base host — the customer's own login subdomain (for
  example https://johnsfloors.builderprime.com). The shared application host app.builderprime.com serves
  the same /api/<resource>/v1 paths and is recorded here as a real, non-placeholder baseURL.
tags:
- CRM
- Home Improvement
- Contractors
- Lead Management
properties:
- type: Documentation
  url: https://www.builderprime.com/blog/open-api-documentation
- type: Authentication
  url: authentication/builder-prime-authentication.yml
- type: ErrorCatalog
  url: errors/builder-prime-problem-types.yml