Skip to main content
GET
/
call-requests
/
{callRequestId}
Get a call request
curl --request GET \
  --url https://voice.growdental.ai/api/partner/v1/call-requests/{callRequestId} \
  --header 'Authorization: Bearer <token>'
{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "practice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "purpose": "<string>", "counts": { "total": 123, "pending": 123, "calling": 123, "completed": 123, "failed": 123, "skipped": 123 }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "context": "<string>", "window": { "start": "2023-11-07T05:31:56Z", "end": "2023-11-07T05:31:56Z", "daily_start": "<string>", "daily_end": "<string>", "days": [ 3 ] }, "contacts": [ { "phone": "<string>", "name": "<string>", "external_ref": "<string>", "outcome": "<string>", "call_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" } ] }

Authorizations

​
Authorization
string
header
required

Partner API key sent as a Bearer token:

Authorization: Bearer gd_live_...

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