> ## Documentation Index > Fetch the complete documentation index at: https://docs.growdental.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get a call request > Returns a single call request with per-contact progress (status, outcome, and the resulting `call_id` once each contact has been dialed). Requires `call-requests:write`. ## OpenAPI ````yaml /openapi.yaml get /call-requests/{callRequestId} openapi: 3.1.0 info: title: GrowDental Partner API version: '2026-07-04' summary: >- Programmatic access to GrowDental's voice-AI calling platform for dental practices. description: > The GrowDental Partner API lets platforms and practice-management systems integrate with GrowDental's voice-AI calling for dental practices: list the practices you have been granted, read call results, fetch recordings, trigger outbound calls, and receive signed webhook events. **Status: early access.** This specification is the published v1 contract. Where the deployed API and this document disagree during early access, the discrepancy is a bug — report it and we will reconcile. ### Access Access is **invite-only**. There is no self-serve signup: partner apps, API keys, and practice grants are issued by the GrowDental team. Contact [partners@growdental.ai](mailto:partners@growdental.ai) to get started. ### Conventions - All request and response bodies are JSON; property names are **snake_case** (`duration_seconds`, `next_cursor`, `enabled_events`). - Errors use one envelope everywhere: `{ "error": "", "message": "" }`. - Requests referencing practices your app has **not** been granted return `404` (never `403`), so practice identifiers cannot be probed. - `GET` endpoints never take request bodies; all filters are query parameters. - Pagination varies by resource: the calls list uses cursor pagination (`limit` + `cursor` in, `data` + `next_cursor` out); the call-requests list uses `limit` + `offset` with a `pagination` object; the practices list is unpaginated. - Every `POST` endpoint honors an `Idempotency-Key` header (24-hour replay window). - Timestamps are ISO 8601 / RFC 3339 UTC strings. ### Rate limits Per API key: **600 requests/minute** by default; bulk write endpoints (call-request creation) have a separate **60 requests/minute** budget. Limited requests receive `429 rate_limited` with a `Retry-After` header (seconds). ### PHI and the BAA gate Scopes that expose protected health information (`transcripts:read`, `recordings:read`, `intake:write`) are hard-gated in code: they return `403 baa_required` until a Business Associate Agreement is on file for your app. Webhook payloads are PHI-minimal by design (IDs, outcomes, and links); PHI travels only over authenticated API pulls. contact: name: GrowDental Partnerships email: partners@growdental.ai url: https://voice.growdental.ai servers: - url: https://voice.growdental.ai/api/partner/v1 description: Production security: - bearerAuth: [] tags: - name: Practices description: Practices your partner app has been granted access to. - name: Calls description: Completed and in-flight calls for granted practices. - name: Recordings description: Short-lived, signed access to call recordings (PHI — BAA required). - name: Call Requests description: Trigger outbound voice-AI calls to one or more contacts. - name: Webhook Endpoints description: Manage the HTTPS endpoints that receive signed event deliveries. paths: /call-requests/{callRequestId}: get: tags: - Call Requests summary: Get a call request description: | Returns a single call request with per-contact progress (status, outcome, and the resulting `call_id` once each contact has been dialed). Requires `call-requests:write`. operationId: getCallRequest parameters: - name: callRequestId in: path required: true description: Call request ID. schema: type: string format: uuid responses: '200': description: The call request. content: application/json: schema: $ref: '#/components/schemas/CallRequestDetail' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' components: schemas: CallRequestDetail: description: A call request with its window, context, and per-contact progress. allOf: - $ref: '#/components/schemas/CallRequest' - type: object required: - context - window - contacts properties: context: type: - string - 'null' description: The free-text context supplied at creation. window: type: object required: - start - end - daily_start - daily_end - days properties: start: type: - string - 'null' format: date-time end: type: - string - 'null' format: date-time daily_start: type: - string - 'null' description: Daily calling-window start (HH:MM, practice-local). daily_end: type: - string - 'null' description: Daily calling-window end (HH:MM, practice-local). days: type: - array - 'null' items: type: integer minimum: 0 maximum: 6 description: Calling days, `0` = Sunday through `6` = Saturday. contacts: type: array items: $ref: '#/components/schemas/CallRequestContact' CallRequest: type: object description: A partner-triggered batch of outbound calls (list representation). required: - id - status - practice_id - purpose - counts - created_at - updated_at properties: id: type: string format: uuid status: type: string enum: - queued - in_progress - completed - paused - cancelled description: | `queued` until dialing begins, `in_progress` while contacts are being worked, `completed` when every contact is terminal. practice_id: type: string format: uuid purpose: type: - string - 'null' counts: $ref: '#/components/schemas/CallRequestCounts' created_at: type: string format: date-time updated_at: type: string format: date-time CallRequestContact: type: object description: Per-contact progress within a call request. required: - phone - name - external_ref - status - outcome - call_id properties: phone: type: - string - 'null' description: The E.164 number you supplied. name: type: - string - 'null' description: The contact's name (first + last), when supplied. external_ref: type: - string - 'null' description: The `external_ref` you supplied for this contact, or `null`. status: type: string enum: - pending - calling - completed - failed - skipped outcome: type: - string - 'null' description: Outcome classification once the contact's call completed. call_id: type: - string - 'null' format: uuid description: The resulting call — fetch it via `GET /calls/{callId}`. Error: type: object description: The error envelope used by every non-2xx response. required: - error - message properties: error: type: string description: Stable machine-readable error code. examples: - invalid_api_key - insufficient_scope - baa_required - not_found - rate_limited message: type: string description: >- Human-readable explanation. Do not parse; codes are stable, messages are not. CallRequestCounts: type: object description: | Aggregate contact-status counts for a call request. Keys beyond the listed ones may appear if new contact statuses are introduced. required: - total - pending - calling - completed - failed - skipped properties: total: type: integer description: Total contacts in the request. pending: type: integer description: Contacts not yet dialed. calling: type: integer description: Contacts currently being dialed. completed: type: integer description: Contacts whose call finished. failed: type: integer description: Contacts that failed after exhausting retries. skipped: type: integer description: Contacts skipped by the dialer. additionalProperties: type: integer responses: Unauthorized: description: | Authentication failed: missing/malformed `Authorization` header (`missing_authorization`), unknown key (`invalid_api_key`), or a revoked key (`key_revoked`). content: application/json: schema: $ref: '#/components/schemas/Error' examples: missingAuthorization: value: error: missing_authorization message: >- Missing or malformed Authorization header. Expected: Authorization: Bearer gd_live_... invalidApiKey: value: error: invalid_api_key message: The provided API key is not valid. keyRevoked: value: error: key_revoked message: This API key has been revoked. Forbidden: description: | The key authenticated but is not allowed: the partner app is suspended (`app_suspended`), the key lacks the required scope (`insufficient_scope`), or a PHI scope was used without a signed BAA (`baa_required`). content: application/json: schema: $ref: '#/components/schemas/Error' examples: appSuspended: value: error: app_suspended message: This partner app is suspended. insufficientScope: value: error: insufficient_scope message: 'This API key does not have the required scope: calls:read' baaRequired: value: error: baa_required message: >- The scope recordings:read exposes PHI and requires a signed BAA. Contact support to complete your BAA. NotFound: description: | Resource not found. Also returned — deliberately, instead of `403` — when the resource exists but belongs to a practice your app has not been granted. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: not_found message: Practice not found. RateLimited: description: Rate limit exceeded for this API key. Honor `Retry-After`. headers: Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' example: error: rate_limited message: Rate limit exceeded. Retry after 12 seconds. headers: RetryAfter: description: Seconds to wait before retrying. schema: type: integer minimum: 1 securitySchemes: bearerAuth: type: http scheme: bearer description: | 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. ````