CustomerBase API

Name: CustomerBase API
Brand: CustomerBase API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCRMContact ManagementapiKey26 EndpointsREST

For Agents

Manage customers, appointments, estimates, jobs, reviews, users, and work requests for a field-service CRM, suitable for dispatch automation and external system sync.

Install Jentic One Beta

Connect the CustomerBase API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the CustomerBase API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with CustomerBase API.

Maintain customer records — list, create, read, update, and delete customers in CustomerBase

Schedule and retrieve appointments tied to customer records and assigned users

Create and read estimates that quote work for a customer

GET STARTED

Start building with CustomerBase API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use CustomerBase API for, with concrete tasks.

★ Dispatch and Scheduling Sync

Keep a third-party calendar or dispatch tool in sync with CustomerBase appointments. List appointments via GET /appointments, create new ones with POST /appointments, and reflect changes back to the external schedule. Suitable for home-services teams running a separate dispatch board or integrating CustomerBase with a field-mobile app.

Call GET /appointments on a 5-minute schedule and upsert each record into the external dispatch board, then POST /appointments for any new bookings created externally

Customer Onboarding from Lead Form

Push leads captured on a marketing site or third-party form into CustomerBase as customer records. POST /customers with the captured fields, then optionally create a work request (POST /work_requests) to track the inbound interest. Useful for service businesses that want a single CRM source of truth without manual data entry.

Call POST /customers with the lead's name, email, phone, and address, then POST /work_requests linking the customer ID to capture the requested service

Estimate and Job Pipeline Tracking

Track the move from quote to completed work by linking estimates and jobs against a customer. POST /estimates creates a quote, POST /jobs converts an accepted estimate into scheduled work, and GET /jobs/{id} retrieves status for ops dashboards. Suitable for owners who want a clean view of conversion from estimate to job.

Call POST /estimates for a new quote, then upon acceptance call POST /jobs referencing the customer ID and estimate to schedule the work

User and Role Provisioning

Provision dispatchers and technicians as the team grows. GET /roles surfaces the assignable roles, POST /users creates a new account, and PUT /users/{id} updates assignments. Useful when a People Ops or IT system is the source of truth for staff and CustomerBase needs to mirror that list.

Call GET /roles to list valid roles, then POST /users with the technician's email, name, and role to grant access

AI Agent Field Service Workflow via Jentic

An AI agent helping a service business owner triage inbound work uses Jentic to call CustomerBase directly. The agent searches for 'create customer', loads POST /customers, supplies the captured fields, and follows up with /work_requests to log the request without bespoke integration code.

Use Jentic to search 'create customer' and execute POST /customers for each lead in an inbox parser, then POST /work_requests for any service request found

Key Endpoints

26 endpoints — jentic publishes the only available openapi specification for customerbase api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/customers

List customers

POST

/customers

Create a customer

GET

/appointments

List appointments

POST

/appointments

Schedule an appointment

POST

/estimates

Create an estimate

POST

/jobs

Create a job

POST

/work_requests

Create a work request

GET

/users

List users

GET

/customers

List customers

POST

/customers

Create a customer

GET

/appointments

List appointments

POST

/appointments

Schedule an appointment

POST

/estimates

Create an estimate

POST

/jobs

Create a job

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

CustomerBase X-Api-Key values are stored encrypted in the Jentic vault and injected into the request header at call time. The agent never sees or stores the raw key.

Intent-based discovery

Agents search by intent (e.g. 'create customer' or 'schedule appointment') and Jentic returns the matching CustomerBase operation with its request-body schema.

Time to first call

Direct CustomerBase integration: 1-2 days for auth, resource modelling, and pagination. Through Jentic: under 1 hour — search, load, execute.

FAQs

Specific to using CustomerBase API through Jentic.

Why is there no official OpenAPI spec for CustomerBase API?

CustomerBase does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call CustomerBase API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the CustomerBase API use?

The API uses an API key sent in the X-Api-Key header on every request. Through Jentic the key is held in the encrypted vault and injected at call time, so the raw key never enters the agent's prompt.

Can I create appointments with the CustomerBase API?

Yes. Call POST /appointments with the customer ID, scheduled time, and any additional fields. Use GET /appointments to list and GET /appointments/{id} to retrieve a specific record.

What are the rate limits for the CustomerBase API?

Rate limits depend on the CustomerBase plan and are not encoded in the spec. Treat the public API as suitable for moderate sync volumes rather than high-frequency polling; check your CustomerBase account for current limits.

How do I create a new customer through Jentic?

Run pip install jentic, search for 'create customer', load POST /customers, and execute it with the lead's name, email, phone, and address. Jentic posts the request and returns the created customer ID.

How do I track a job from estimate to completion?

Create the quote with POST /estimates, then call POST /jobs referencing the customer ID once the estimate is accepted. GET /jobs/{id} retrieves the current status for dashboards.

CustomerBase API

Connect the CustomerBase API to your agent

Capabilities

Start building with CustomerBase API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs