Skip to main content
These pages are generated from the App API’s own OpenAPI spec, which is built from the same schemas that validate every request. Field names, types and limits here are exactly what the API enforces.

​
Base URL

​
Conventions

  • Every endpoint except /health and /version needs Authorization: Bearer <organization key>. See authentication.
  • The API is read-only: every endpoint is a GET.
  • Lists return { data, has_more, next_cursor }. See pagination.
  • Timestamps are ISO 8601 with an offset. Missing values are null.
  • Errors return { error: { code, message, request_id } }. See errors.

​
Try it

Each endpoint page has a request panel. Paste an organization key, fill in parameters and send. Requests run against your real organization data, so use a key with only the read permissions you need.

​
Endpoint groups

Account

Current key, capabilities, limits, health

Calls

Call history, change feed, scores, analysis, coaching

Transcripts

Full text, timed segments, search

Comments

Coaching comments on calls

Reps and teams

Organization, reps, teams, members

Analytics

Overview, leaderboard, trends, insights, performance

Deals and CRM

Deals, accounts, contacts, pipeline

Playbook

Playbook, versions, scorecard, trackers

Playlists

Organization playlists

Training

Courses, enrollments, progress, certificates

Usage and audit

Usage totals and audit trail

​
Versioning

The path is /v1. Every response carries a Parlay-Version header. New fields and endpoints are added to /v1 without notice, so ignore fields you do not recognize. Breaking changes would ship under a new version.