Integrate CrystalQore with your CRM, reporting stack, or internal tools using the REST API.

Developers

The CrystalQore API lets you list people and presence, pull call records, manage contacts, start conversations, originate calls, and read files, calendar, and fax — all scoped to one organization.

Enterprise

API access is an Enterprise capability. CrystalQore operators issue keys from API Clients. Each key is shown once (cq_ + 64 hex characters). The tenant must have the platform.api entitlement.

Base URL

https://app.crystalqore.com/api/v1

Every response is JSON. Success and error share a stable envelope — see Errors and Pagination.

Quickstart

Get a key — Ask your CrystalQore operator for an API client scoped to your tenant and the permissions you need. Store the key in a secret manager. It is not shown again.

Call users — Confirm the key, tenant, and entitlement with a read:

curl -sS "https://app.crystalqore.com/api/v1/users?limit=5" \
  -H "X-API-Key: $CRYSTALQORE_API_KEY" \
  -H "X-Tenant-Id: $CRYSTALQORE_TENANT_ID"

Try it live — Paste the same credentials into the API Playground. GET calls are safe to explore. POST and PUT change live data — especially click-to-dial.

Download the OpenAPI 3.1 spec: /openapi/crystalqore-v1.yaml. Use it in your codegen, Bruno, or Insomnia collection.

What you can call

Resource	Methods	User header	Permission
Users	`GET`	Optional	`users`
Call records	`GET`	Optional (scopes to that user)	`cdr`
Contacts	`GET`, `POST`	Required for `POST`	`contacts`
Click to dial	`POST`	Required	`click2dial`
Chat	`GET`, `POST`	Required	`chat`
Files	`GET`	Optional	`files`
Calendar	`GET`, `POST`	Required	`calendar`
Fax	`GET`	Optional	`fax`
Presence	`GET`, `PUT`	Required for `PUT`	`presence`

Developers

Developers

Base URL

Quickstart

What you can call

Recipes

Next

On this page