Skip to main content
GET
Get a call request

Authorizations

Authorization
string
header
required

Partner API key sent as a Bearer token:

Keys are issued by the GrowDental team (invite-only), shown once at creation, and stored server-side only as a SHA-256 hash. Key format: gd_live_ (or gd_test_) followed by a 43-character base62 secret (~256 bits of entropy). To rotate, request a new key, deploy it, then ask us to revoke the old one — both keys work during the overlap.

Path Parameters

callRequestId
string<uuid>
required

Call request ID.

Response

The call request.

A call request with its window, context, and per-contact progress.

id
string<uuid>
required
status
enum<string>
required

queued until dialing begins, in_progress while contacts are being worked, completed when every contact is terminal.

Available options:
queued,
in_progress,
completed,
paused,
cancelled
practice_id
string<uuid>
required
purpose
string | null
required
counts
object
required

Aggregate contact-status counts for a call request. Keys beyond the listed ones may appear if new contact statuses are introduced.

created_at
string<date-time>
required
updated_at
string<date-time>
required
context
string | null
required

The free-text context supplied at creation.

window
object
required
contacts
object[]
required