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

# Retrieve a Call

> Retrieves the details of an existing call.



## OpenAPI

````yaml GET /calls/{id}
openapi: 3.1.0
info:
  title: Moonbase REST API
  version: v0
servers:
  - url: https://api.moonbase.ai/v0
security:
  - bearer: []
tags:
  - name: Inboxes
    description: Manage your inboxes, conversations, and messages
  - name: Collections
    description: Manage your collections and items
  - name: Marketing
    description: Manage your marketing campaigns and forms
  - name: Activities
    description: View activities and capture calls
  - name: Library
    description: Manage your meetings, files, and notes
paths:
  /calls/{id}:
    get:
      tags:
        - Activities
      summary: Retrieve a call
      description: Retrieves the details of an existing call.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The ID of the call to retrieve.
          explode: true
        - name: include[]
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - transcript
                - note
                - summary
          description: >-
            Specifies which related objects to include in the response. Valid
            options are `transcript`, `note`, and `summary`.
          explode: true
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Call'
              examples:
                Get call:
                  summary: Get call
                  value:
                    id: 1CLJt2v5aNd8G5SGzEaeVU
                    type: call
                    participants: []
                    tags: []
                    created_at: '2025-02-17T16:00:00.000Z'
                    updated_at: '2025-02-17T16:00:00.000Z'
                    direction: incoming
                    start_at: '2025-02-17T15:00:00.000Z'
                    end_at: '2025-02-17T15:30:00.000Z'
                    provider: openphone
                    provider_id: openphone_id_000000000004
                    provider_status: completed
                    provider_metadata:
                      answered_at: '2025-02-17T15:10:00Z'
                      answered_by: UShjUatqtF
                      completed_at: '2025-02-17T15:30:00Z'
                      user_id: UShjUatqtF
                      phone_number_id: PN72zMikBJ
                      conversation_id: CN00000000000000000000000000000001
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                Default:
                  summary: Default
                  value:
                    type: errors
                    errors:
                      - type: error
                        status: '400'
                        title: Bad Request
                        detail: >-
                          The request could not be understood due to malformed
                          syntax or invalid parameters.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                Default:
                  summary: Default
                  value:
                    type: errors
                    errors:
                      - type: error
                        status: '401'
                        title: Unauthorized
                        detail: >-
                          Invalid or missing API key or JWT. You should provide
                          your Moonbase API Key or JWT in the authorization
                          header, in the format: "Authorization: Bearer
                          MOONBASE_API_KEY"
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                Default:
                  summary: Default
                  value:
                    type: errors
                    errors:
                      - type: error
                        status: '403'
                        title: Forbidden
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                Not found:
                  summary: Not found
                  value:
                    type: errors
                    errors:
                      - type: error
                        status: '404'
                        title: Not Found
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                Default:
                  summary: Default
                  value:
                    type: errors
                    errors:
                      - type: error
                        status: '429'
                        title: Too Many Requests
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                Default:
                  summary: Default
                  value:
                    type: errors
                    errors:
                      - type: error
                        status: '500'
                        title: Internal Server Error
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                Default:
                  summary: Default
                  value:
                    type: errors
                    errors:
                      - type: error
                        status: '503'
                        title: Service Unavailable
                        detail: >-
                          The service is temporarily unavailable, please try
                          again later.
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Moonbase from '@moonbaseai/sdk';

            const client = new Moonbase({
              apiKey: process.env['MOONBASE_API_KEY'], // This is the default and can be omitted
            });

            const call = await client.calls.retrieve('id');

            console.log(call.id);
        - lang: Python
          source: |-
            import os
            from moonbase import Moonbase

            client = Moonbase(
                api_key=os.environ.get("MOONBASE_API_KEY"),  # This is the default and can be omitted
            )
            call = client.calls.retrieve(
                id="id",
            )
            print(call.id)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/moonbaseai/moonbase-sdk-go\"\n\t\"github.com/moonbaseai/moonbase-sdk-go/option\"\n)\n\nfunc main() {\n\tclient := moonbase.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcall, err := client.Calls.Get(\n\t\tcontext.TODO(),\n\t\t\"id\",\n\t\tmoonbase.CallGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", call.ID)\n}\n"
        - lang: Ruby
          source: |-
            require "moonbase"

            moonbase = Moonbase::Client.new(api_key: "My API Key")

            call = moonbase.calls.retrieve("id")

            puts(call)
components:
  schemas:
    Call:
      title: Call
      description: >-
        The Call object represents a phone call that has been logged in the
        system. It contains details about the participants, timing, and outcome
        of the call.
      type: object
      properties:
        type:
          description: >-
            String representing the object’s type. Always `call` for this
            object.
          type: string
          const: call
        id:
          description: Unique identifier for the object.
          type: string
        direction:
          description: The direction of the call, either `incoming` or `outgoing`.
          type: string
          enum:
            - incoming
            - outgoing
        start_at:
          description: The time the call started, as an ISO 8601 timestamp in UTC.
          type: string
          format: date-time
        answered_at:
          description: >-
            The time the call was answered, if available, as an ISO 8601
            timestamp in UTC.
          type: string
          format: date-time
        end_at:
          description: >-
            The time the call ended, if available, as an ISO 8601 timestamp in
            UTC.
          type: string
          format: date-time
        provider:
          description: The name of the phone provider that handled the call.
          type: string
          enum:
            - openphone
            - user
            - zoom_phone
        provider_id:
          description: The unique identifier for the call from the provider's system.
          type: string
        provider_status:
          description: The current status of the call.
          type: string
        provider_metadata:
          description: A hash of additional metadata from the provider.
          type: object
          additionalProperties: true
        participants:
          description: The participants involved in the call.
          type: array
          items:
            $ref: '#/components/schemas/CallParticipant'
        tags:
          description: The tags currently applied to this call.
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        transcript:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/CallTranscript'
        note:
          description: >
            Any notes taken during or after the call. Returns `null` if no note
            exists.


            **Note:** Only present when requested using the `include` query
            parameter.
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/Note'
        summary:
          description: >
            A summary of the call, or `null` if no summary has been generated
            yet.


            **Note:** Only present when requested using the `include` query
            parameter.
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/Note'
        created_at:
          description: >-
            Time at which the object was created, as an ISO 8601 timestamp in
            UTC.
          type: string
          format: date-time
        updated_at:
          description: >-
            Time at which the object was last updated, as an ISO 8601 timestamp
            in UTC.
          type: string
          format: date-time
      required:
        - provider_id
        - provider_status
        - direction
        - start_at
        - provider
        - type
        - id
        - participants
        - tags
        - created_at
        - updated_at
    Errors:
      title: Errors
      description: >-
        The Errors object is a container that holds multiple Error objects when
        an API request encounters several validation or processing issues. This
        allows the API to return comprehensive feedback about all problems
        encountered in a single response.
      type: object
      properties:
        type:
          type: string
          const: errors
        errors:
          description: A list of `Error` objects.
          type: array
          items:
            $ref: '#/components/schemas/Error'
      required:
        - type
    CallParticipant:
      title: CallParticipant
      description: Represents a participant in a call.
      type: object
      properties:
        type:
          description: >-
            String representing the object’s type. Always `call_participant` for
            this object.
          type: string
          const: call_participant
        id:
          description: Unique identifier for the object.
          type: string
        role:
          description: >-
            The role of the participant in the call. Can be `caller`, `callee`,
            or `other`.
          type: string
          enum:
            - caller
            - callee
            - other
        phone:
          description: The E.164 formatted phone number of the participant.
          type: string
        person:
          $ref: '#/components/schemas/ItemPointer'
        organization:
          $ref: '#/components/schemas/ItemPointer'
      required:
        - phone
        - role
        - type
        - id
    Tag:
      title: Tag
      description: >-
        A Tag is a label that can be applied to supported resources (such as
        conversations, calls, and meetings) for organization and filtering.
      type: object
      properties:
        type:
          description: String representing the object’s type. Always `tag` for this object.
          type: string
          const: tag
        id:
          description: Unique identifier for the object.
          type: string
        name:
          description: The name of the tag.
          type: string
        color:
          $ref: '#/components/schemas/NamedColor'
          description: The color for the tag.
      required:
        - name
        - type
        - id
        - color
    CallTranscript:
      title: CallTranscript
      description: ''
      type: object
      properties:
        cues:
          type: array
          items:
            $ref: '#/components/schemas/CallTranscriptCue'
      required:
        - cues
    Note:
      title: Note
      description: >-
        The Note object represents a block of text content, often used for
        meeting notes or summaries.
      type: object
      properties:
        type:
          description: >-
            String representing the object’s type. Always `note` for this
            object.
          type: string
          const: note
        id:
          description: Unique identifier for the object.
          type: string
        lock_version:
          description: >-
            The current lock version of the note for optimistic concurrency
            control.
          type: integer
        body:
          $ref: '#/components/schemas/FormattedText'
          description: The main content of the note.
        created_at:
          description: >-
            Time at which the object was created, as an ISO 8601 timestamp in
            UTC.
          type: string
          format: date-time
        updated_at:
          description: >-
            Time at which the object was last updated, as an ISO 8601 timestamp
            in UTC.
          type: string
          format: date-time
        title:
          description: An optional title for the note.
          type: string
        summary:
          description: A short, system-generated summary of the note's content.
          type: string
        creator:
          description: The person that created the note.
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ItemPointer'
        associations:
          description: A list of items, meetings or calls this note is associated with.
          type: array
          items:
            $ref: '#/components/schemas/NoteAssociationPointer'
      required:
        - type
        - id
        - lock_version
        - body
        - created_at
        - updated_at
        - associations
    Error:
      title: Error
      description: >-
        The Error object represents a single error that occurred during API
        request processing. It provides detailed information about what went
        wrong, including a unique identifier, status code, and human-readable
        descriptions to help developers understand and resolve the issue.
      type: object
      properties:
        type:
          type: string
          const: error
        id:
          description: A unique identifier for this specific error instance.
          type: string
        status:
          description: The HTTP status code for this problem, as a string.
          type: string
        code:
          description: An application-specific error code string.
          type: string
        title:
          description: A short, human-readable summary of the problem.
          type: string
        detail:
          description: A human-readable explanation of this specific error.
          type: string
        source:
          $ref: '#/components/schemas/ErrorSource'
          description: >-
            An object containing more specific information about the part of the
            request that caused the error.
        meta:
          type: object
          additionalProperties: true
      required:
        - type
    ItemPointer:
      title: ItemPointer
      description: >-
        A reference to an `Item` within a specific `Collection`, providing the
        context needed to locate the item.
      type: object
      properties:
        type:
          description: >-
            String representing the object’s type. Always `item` for this
            object.
          type: string
          const: item
        id:
          description: Unique identifier of the item.
          type: string
        collection:
          $ref: '#/components/schemas/CollectionPointer'
          description: A reference to the `Collection` containing this item.
      required:
        - collection
        - type
        - id
    NamedColor:
      type: string
      enum:
        - amber
        - blue
        - cyan
        - emerald
        - fuchsia
        - green
        - indigo
        - lime
        - lunar
        - orange
        - pink
        - purple
        - red
        - rose
        - sky
        - teal
        - violet
        - yellow
      description: >-
        One of Moonbase's standard color names. Moonbase renders these
        consistently across light and dark modes.
    CallTranscriptCue:
      title: CallTranscriptCue
      description: ''
      type: object
      properties:
        from:
          type: number
        to:
          type: number
        text:
          type: string
        speaker:
          $ref: '#/components/schemas/CallTranscriptSpeaker'
      required:
        - from
        - to
        - text
        - speaker
    FormattedText:
      title: FormattedText
      description: >-
        Structured content that can be rendered in multiple formats, currently
        supporting Markdown.
      type: object
      properties:
        markdown:
          description: The content formatted as Markdown text.
          type: string
      required: []
    NoteAssociationPointer:
      title: NoteAssociationPointer
      description: A reference to a call, meeting, or item associated with the note.
      oneOf:
        - $ref: '#/components/schemas/CallPointer'
        - $ref: '#/components/schemas/ItemPointer'
        - $ref: '#/components/schemas/MeetingPointer'
      discriminator:
        propertyName: type
        mapping:
          call:
            $ref: '#/components/schemas/CallPointer'
          item:
            $ref: '#/components/schemas/ItemPointer'
          meeting:
            $ref: '#/components/schemas/MeetingPointer'
    ErrorSource:
      title: ErrorSource
      description: >-
        The ErrorSource object provides additional context about the specific
        part of an API request that caused an error. It can point to either a
        field in the request document or a query parameter that contains invalid
        data.
      type: object
      properties:
        pointer:
          description: >-
            A JSON Pointer [RFC6901] to the associated entity in the request
            document.
          type: string
        parameter:
          description: A string indicating which URI query parameter caused the error.
          type: string
      required: []
    CollectionPointer:
      title: CollectionPointer
      description: >-
        A lightweight reference to a `Collection`, containing the minimal
        information needed to identify it.
      type: object
      properties:
        type:
          description: >-
            String representing the object’s type. Always `collection` for this
            object.
          type: string
          const: collection
        id:
          description: Unique identifier of the collection.
          type: string
        ref:
          description: The stable, machine-readable reference identifier of the collection.
          type: string
      required:
        - type
        - id
        - ref
    CallTranscriptSpeaker:
      title: CallTranscriptSpeaker
      description: ''
      type: object
      properties:
        label:
          type: string
        attendee_id:
          type: string
      required: []
    CallPointer:
      title: CallPointer
      type: object
      properties:
        type:
          type: string
          const: call
        id:
          type: string
      required:
        - type
        - id
    MeetingPointer:
      title: MeetingPointer
      type: object
      properties:
        type:
          type: string
          const: meeting
        id:
          type: string
      required:
        - type
        - id
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: Your Moonbase API key.

````