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

> ## Agent Instructions
> Use the public API base URL: https://api.teamfollowup.ai/api.
> Authenticate public API requests with Authorization: Bearer YOUR_API_KEY.
> Use product-owned terms: agents, calls, campaigns, contacts, phone numbers, billing, and configuration.

# Get call by call id

> Fetch one tenant-scoped call by its platform call id, including the transcript and recorded fields. Used when another product surface deep-links into a call drawer. Customer roles: `agency_admin`, `project_user`.

Required API key scope: `calls:read`.



## OpenAPI

````yaml /openapi.yaml get /api/call-history/by-call-id/{callId}
openapi: 3.1.0
info:
  title: TFUAI Server API
  version: 1.0.0
  description: >-
    API reference for the TFUAI SaaS server.


    All published endpoints are mounted under `/api`. Responses use a standard
    envelope: `{ "success": true, ... }` on success and `{ "success": false,
    "error": "..." }` on failure.


    Product API modules are being launched module by module. This spec currently
    exposes only contracted public modules.


    Authenticate public API requests with an API key in the `Authorization`
    header: `Authorization: Bearer YOUR_API_KEY`.
servers:
  - url: https://api.teamfollowup.ai
    description: Production API origin. Public API paths are under /api.
  - url: https://devapi.teamfollowup.ai
    description: Development API origin. Public API paths are under /api.
security: []
tags:
  - name: Agents
    description: Manage voice agents, campaigns, workflows, and outcomes.
  - name: Analytics
    description: >-
      Minimal, non-billing performance summary: volume, conversion, and pickup
      metrics.
  - name: Calls
    description: Review calls, test runs, and execution history.
  - name: Campaign Workflows
    description: >-
      What runs after a call lands: for each outcome (booked, opted out, asked
      for a callback…), an ordered chain of actions — tag the contact, move a
      pipeline stage, send an SMS, book an appointment. Stored as a graph:
      `nodes` are the actions, `edges` say what follows what, and
      `dispositionEntries` maps each outcome to the node its chain starts at.


      **Pick the narrowest endpoint that does the job.**


      | To | Call | |

      | --- | --- | --- |

      | See what fires per outcome | `GET .../workflow/digest` | Reads as plain
      text, no graph walking |

      | Add steps to an outcome | `POST .../outcomes/{outcome}/nodes` | Server
      derives node ids, edge ids, handles, layout |

      | Change a message, tag or setting | `PATCH .../workflow` | Merges;
      carries no graph, so it cannot damage one |

      | Remove one step | `DELETE .../nodes/{nodeId}` | Also re-links the chain
      around it |

      | Author or replace the whole graph | `PUT .../workflow` | Replaces
      everything you send |


      `PUT` is the only one that can re-wire, position nodes, build an `if`,
      save an unconfigured draft, or copy a whole workflow — and the only one
      that can overwrite a change someone else made after you read it. Use it
      when you are genuinely authoring the graph, and send `expectedVersion`
      when you do. For everything else the narrower endpoints are both easier
      and safer.
  - name: Contacts
    description: Contact list, filters, contact call history, and do-not-call actions.
  - name: GHL
    description: CRM variables and contact helpers used by agent and campaign setup flows.
  - name: Phone Numbers
    description: >-
      Caller ID pool, number search, assignment, movement, and release
      endpoints.
  - name: Power Dialer
    description: >-
      Power Dialer queue, lead cadence, callback, parked lead, and campaign
      schedule endpoints.
  - name: Projects
    description: >-
      Project management endpoints: list, update, disconnect, configure project
      campaigns, and validate setup.
  - name: Skills and Tools
    description: Manage reusable agent behaviors and in-call tool descriptions.
  - name: Voices
    description: Voice catalogue endpoints for choosing the voice used by an agent.
paths:
  /api/call-history/by-call-id/{callId}:
    get:
      tags:
        - Calls
      summary: Get call by call id
      description: >-
        Fetch one tenant-scoped call by its platform call id, including the
        transcript and recorded fields. Used when another product surface
        deep-links into a call drawer. Customer roles: `agency_admin`,
        `project_user`.


        Required API key scope: `calls:read`.
      operationId: get-call-by-call-id
      parameters:
        - name: callId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
          description: Platform call id returned in call events and call-history records.
          example: call_123
      responses:
        '200':
          description: Matching call with transcript and recorded fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallsRecordDetailResponse'
              examples:
                default:
                  value:
                    success: true
                    data:
                      id: call_row_123
                      callId: call_123
                      date: '2026-07-08'
                      dateTime: '2026-07-08T16:30:00.000Z'
                      leadName: Alex Morgan
                      phoneNumber: '+14155559876'
                      direction: outbound
                      status: ended
                      duration: 184
                      agent: Front Desk Agent
                      callSummary: Alex asked for pricing and requested a callback.
                      projectName: Acme Clinic
                      recordingUrl: https://app.example.test/recordings/call_123
                      cost: 2.18
                      agentType: appointment_booking
                      campaignId: campaign_speed_to_lead_123
                      campaignName: Speed to Lead
                      disposition:
                        type: callBack
                        label: Callback
                        color: amber
                      transcript: |-
                        Agent: Hi, this is the front desk...
                        User: I wanted to ask about pricing.
                      fields:
                        - key: roof_age
                          value: 12
                        - key: wants_quote
                          value: true
                      transcriptSource: live
        '400':
          description: Validation failed or the request is malformed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallsErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: VALIDATION
                    message: A required value is missing.
        '401':
          description: Missing or invalid authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallsErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: Unauthorized
                    message: Authentication required.
        '403':
          description: Authenticated but not permitted to access the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallsErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: Forbidden
                    message: You do not have access to this project.
        '404':
          description: Resource not found or not visible to the caller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallsErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: NotFound
                    message: Call not found or access denied.
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallsErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: TooManyRequests
                    message: Too many requests, please try again later.
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallsErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: InternalError
                    message: Unexpected server error.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl --request GET \
              --url https://api.teamfollowup.ai/api/call-history/by-call-id/{callId} \
              --header 'Authorization: Bearer YOUR_API_KEY'
components:
  schemas:
    CallsRecordDetailResponse:
      type: object
      additionalProperties: false
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/CallsRecordDetail'
    CallsErrorResponse:
      type: object
      additionalProperties: {}
      required:
        - success
        - error
        - message
      properties:
        success:
          type: boolean
        error:
          type: string
          description: Machine-readable error code.
          example: VALIDATION
        message:
          type: string
          description: Human-readable explanation safe to show to an operator.
          example: A required value is missing.
    CallsRecordDetail:
      type: object
      additionalProperties: false
      required:
        - id
        - callId
        - date
        - dateTime
        - phoneNumber
        - direction
        - status
        - duration
        - agent
        - projectName
        - transcriptSource
      properties:
        id:
          type: string
          description: Call record id. Use it with Get call.
          example: call_row_123
        callId:
          type:
            - string
            - 'null'
          description: Platform call id.
          example: call_123
        date:
          type: string
          example: '2026-07-08'
        dateTime:
          type: string
          format: date-time
          example: '2026-07-08T16:30:00.000Z'
        leadName:
          type:
            - string
            - 'null'
          example: Alex Morgan
        phoneNumber:
          type: string
          example: '+14155559876'
        direction:
          type: string
          enum:
            - inbound
            - outbound
            - ''
          example: outbound
        status:
          type: string
          example: ended
        duration:
          type: integer
          minimum: 0
          example: 184
        agent:
          type: string
          example: Front Desk Agent
        callSummary:
          type: string
          example: Alex asked for pricing and requested a callback.
        projectName:
          type: string
          example: Acme Clinic
        recordingUrl:
          type:
            - string
            - 'null'
          example: https://app.example.test/recordings/call_123
        cost:
          type:
            - number
            - 'null'
          description: >-
            Viewer-safe cost for the current account channel, or null when the
            call is not yet costed.
          example: 2.18
        agentType:
          type:
            - string
            - 'null'
          description: Agent type that placed the call, as named by the Agents API.
          example: appointment_booking
        campaignId:
          type:
            - string
            - 'null'
          example: campaign_speed_to_lead_123
        campaignName:
          type:
            - string
            - 'null'
          example: Speed to Lead
        disposition:
          anyOf:
            - $ref: '#/components/schemas/CallsOutcome'
            - type: 'null'
        transcript:
          type:
            - string
            - 'null'
          description: >-
            Full call transcript, sourced on demand from the voice platform.
            Null when the platform could not be reached (see transcriptSource).
          example: |-
            Agent: Hi, this is the front desk...
            User: I wanted to ask about pricing.
        fields:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/CallsRecordedField'
          description: >-
            Recorded custom fields for this call. Empty array when the agent
            captured none; null when the transcript source was unavailable.
        transcriptSource:
          type: string
          enum:
            - live
            - unavailable
          description: >-
            Where transcript and fields came from. `live` means they were
            fetched for this request; `unavailable` means the live fetch failed
            and the record fell back to stored data only.
          example: live
    CallsOutcome:
      type: object
      additionalProperties: false
      required:
        - type
        - label
        - color
      properties:
        type:
          type: string
          example: callBack
        label:
          type: string
          example: Callback
        color:
          type: string
          example: amber
    CallsRecordedField:
      type: object
      additionalProperties: false
      required:
        - key
        - value
      description: >-
        One recorded custom field. `key` matches an agent analysis field;
        `value` follows that field's type (text, number, boolean, or choice).
      properties:
        key:
          type: string
          example: roof_age
        value:
          description: Recorded value. Type follows the field definition.
          example: 12
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.'

````