CRM API Access

The CRM API lets you read and write your customer data programmatically, so you can integrate Frontdesk with your own tools, scripts, and backends.

This feature is rolling out gradually. If you do not see the API Integrations button in your CRM, the API is not enabled for your account yet. Contact support to request access.

Opening the API documentation

  1. Open CRM (Customers) from the dashboard sidebar.
  2. Click API Integrations in the tab row.

This opens the CRM API Documentation page, an in-app reference with endpoint details, parameter tables, response examples, and copy-ready code snippets in cURL, JavaScript, and Python.

Managing your API key

Your API key lives in the Manage Your API Key section of the documentation page.

  • Generate: click Generate API Key to create your key. The key row shows a masked value; use the eye icon to reveal it and the copy icon to copy it. The section also shows the key's status (Active or Inactive) and creation date.
  • Regenerate: click Regenerate to replace the key with a new one. The old key stops working, so update any integrations that use it.
  • Delete: click Delete to revoke the key entirely.

Keep your API key secure. It provides full access to your customer data, so do not commit it to public repositories or ship it in client-side code. If it is ever exposed, regenerate it immediately.

Authentication

Every request must include your API key in a header. Two forms are accepted:

  • X-API-Key: your-api-key-here
  • Authorization: Bearer your-api-key-here

The base URL for customer endpoints is https://www.247aireceptionist.com/api/v1/customers.

What the API covers

At a high level, the API supports:

  • List customers -- GET /customers returns a paginated list with page and pageSize parameters, plus searching, sorting, and filtering by custom field values (for example, smart.status[in]=active,pending or smart.revenue_impact[gt]=5000).
  • Get a customer -- GET /customers/{customer_id} fetches a single record.
  • Look up a customer -- GET /customers/lookup finds records by phone number or email.
  • Create a customer -- POST /customers with name, email, phone, and a variables object for custom field values. This endpoint does not check for duplicates, so look the customer up first if you need to avoid them.
  • Update a customer -- PATCH /customers/{customer_id} changes core fields or custom field values.
  • Delete a customer -- DELETE /customers/{customer_id} removes the record. You can also delete a single field value with the variableKey query parameter.
  • Custom objects -- endpoints for creating, listing, updating, and deleting custom object types and their records, plus linking and unlinking objects to contacts.

For exact request and response shapes, use the in-app reference. It is always current with your account and includes runnable examples for each endpoint.

Tips

  • Use lookup before create -- pair GET /customers/lookup with POST /customers to avoid duplicate records for the same phone number.
  • Filter server-side -- custom field filters on the list endpoint are faster than pulling every page and filtering in your own code.