> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peerlogic.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get call purpose



## OpenAPI

````yaml /openapi/peerlogic-api.json get /api/calls/{call_pk}/purposes/{id}/
openapi: 3.1.0
info:
  title: Peerlogic API
  version: 1.0.0
  description: >-
    Customer-facing API reference for accessing Peerlogic calls, insights,
    conversations, tasks, opportunities, subscriptions, and events.
servers:
  - url: https://api.prod.peerlogic.com
    description: Production
security: []
tags:
  - name: Authentication
    description: Obtain an access token for authenticated API requests.
  - name: Call insights
    description: Call records and aggregate performance insights.
  - name: Transcripts
    description: Transcripts, summaries, sentiment, pauses, and call-purpose details.
  - name: Aimee
    description: Aimee activity, configuration, and performance insights.
  - name: Conversations
    description: Conversation records, messages, and conversation actions.
  - name: Tasks
    description: Customer tasks and task workflow actions.
  - name: Opportunities
    description: Opportunities and follow-up reporting.
  - name: Subscriptions and events
    description: >-
      Create and manage event subscriptions, then inspect event records and
      analytics. For the complete webhook delivery flow, see the Webhooks and
      subscriptions guide.
  - name: Organizations and practices
    description: >-
      Discover the organizations and practices available to the authenticated
      account.
  - name: Contacts and patients
    description: Find contacts and patients for caller recognition and related workflows.
  - name: Appointments
    description: Retrieve appointment history and upcoming appointments for a patient.
  - name: Messaging
    description: Send practice messages, including missed-call recovery outreach.
  - name: Call recordings
    description: Retrieve recording metadata and secure audio URLs for calls.
paths:
  /api/calls/{call_pk}/purposes/{id}/:
    parameters:
      - name: call_pk
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: A unique value identifying this call purpose.
        required: true
        schema:
          type: string
    get:
      tags:
        - Transcripts
      summary: Get call purpose
      operationId: calls_purposes_read
      responses:
        '200':
          description: Successful response for get call purpose.
          content:
            application/json:
              schema:
                required:
                  - call_purpose_type
                  - call
                type: object
                properties:
                  id:
                    title: Id
                    type: string
                    readOnly: true
                    minLength: 1
                  outcomes:
                    type: array
                    items:
                      required:
                        - call_outcome_type
                        - call_purpose
                      type: object
                      properties:
                        id:
                          title: Id
                          type: string
                          readOnly: true
                          minLength: 1
                        reasons:
                          type: array
                          items:
                            required:
                              - call_outcome_reason_type
                              - call_outcome
                            type: object
                            properties:
                              id:
                                title: Id
                                type: string
                                readOnly: true
                                minLength: 1
                              created_at:
                                title: Created at
                                type: string
                                format: date-time
                                readOnly: true
                              modified_at:
                                title: Modified at
                                type: string
                                format: date-time
                                readOnly: true
                              call_outcome_reason_type:
                                title: Call outcome reason type
                                type: string
                                enum:
                                  - >-
                                    not_enough_information_possesed_by_patient_or_agent
                                  - >-
                                    patient_lacks_information_to_complete_request
                                  - >-
                                    practice_lacks_information_to_complete_request
                                  - procedure_not_offered
                                  - treatment_not_offered
                                  - patient_ineligible_for_treatment
                                  - caller_indifference
                                  - insurance
                                  - insurance_not_taken
                                  - pricing
                                  - financial
                                  - lost
                                  - too_expensive
                                  - scheduling
                                  - day_or_time_not_available
                                  - call_interrupted
                                  - call_not_connected
                                  - others
                                  - not_applicable
                                  - incorrect_dental_code
                                  - incomplete_information_on_claim
                                  - insurance_coverage_limit_annual
                                  - insurance_coverage_limit_lifetime
                                  - insurance_coverage_time_limit
                                  - insurance_incorrect_beneficiary_information
                                  - insurance_coverage_expired
                                  - insurance_coordination_of_benefits
                                  - insurance_preauthorization_not_obtained
                                  - insurance_procedure_not_covered
                              created_by:
                                title: The user that is automatically assigned
                                type: string
                                readOnly: true
                                nullable: true
                              modified_by:
                                title: The user that is automatically assigned
                                type: string
                                readOnly: true
                                nullable: true
                              call_outcome:
                                title: The source outcome
                                type: string
                          readOnly: true
                        created_at:
                          title: Created at
                          type: string
                          format: date-time
                          readOnly: true
                        modified_at:
                          title: Modified at
                          type: string
                          format: date-time
                          readOnly: true
                        call_outcome_type:
                          title: Call outcome type
                          type: string
                          enum:
                            - success
                            - failure
                            - not_applicable
                        created_by:
                          title: The user that is automatically assigned
                          type: string
                          readOnly: true
                          nullable: true
                        modified_by:
                          title: The user that is automatically assigned
                          type: string
                          readOnly: true
                          nullable: true
                        call_purpose:
                          title: The source purpose for this outcome
                          type: string
                    readOnly: true
                  created_at:
                    title: Created at
                    type: string
                    format: date-time
                    readOnly: true
                  modified_at:
                    title: Modified at
                    type: string
                    format: date-time
                    readOnly: true
                  call_purpose_type:
                    title: Call purpose type
                    type: string
                    enum:
                      - new_appointment
                      - reschedule
                      - confirm_appointment
                      - cancel_appointment
                      - inquiry_administrative
                      - inquiry_patient_education
                      - inquiry_er
                      - pricing
                      - request_referral
                      - request_medical_records
                      - request_prescription
                      - billing
                      - transfer_care
                      - administrative
                      - employment
                      - personal
                      - others
                      - insurance_authorization
                      - insurance_verification
                      - insurance_claim
                  created_by:
                    title: The user that is automatically assigned
                    type: string
                    readOnly: true
                    nullable: true
                  modified_by:
                    title: The user that is automatically assigned
                    type: string
                    readOnly: true
                    nullable: true
                  call:
                    title: Purpose of the call
                    type: string
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
              example:
                detail: '''Authorization'' header is required'
        '403':
          description: >-
            The authenticated account does not have permission to perform this
            operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionError'
              example:
                message: No permissions assigned to permit access to this endpoint.
        '404':
          description: >-
            The requested resource was not found or is not accessible to the
            authenticated account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
              example:
                detail: The requested resource was not found.
      security:
        - bearerAuth: []
components:
  schemas:
    AuthenticationError:
      title: Authentication error
      type: object
      additionalProperties: true
      required:
        - detail
      properties:
        detail:
          type: string
          description: Why authentication failed.
    PermissionError:
      title: Permission error
      type: object
      additionalProperties: false
      required:
        - message
      properties:
        message:
          type: string
          description: Why access was denied.
    NotFoundError:
      title: Not found error
      type: object
      additionalProperties: false
      required:
        - detail
      properties:
        detail:
          type: string
          description: Why the requested resource could not be returned.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer access token issued by Peerlogic.

````

## Related topics

- [List call purposes](/peerlogic-api-reference/transcripts/list-call-purposes.md)
- [Get call outcome](/peerlogic-api-reference/transcripts/get-call-outcome.md)
- [Get industry call benchmarks](/peerlogic-api-reference/call-insights/get-industry-call-benchmarks.md)
- [Get call outcome reason](/peerlogic-api-reference/transcripts/get-call-outcome-reason.md)
- [Get call counts by practice](/peerlogic-api-reference/call-insights/get-call-counts-by-practice.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.