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

# Get a Call

> Reads a call of the team back, by its id or, for a call logged through the API, by the externalId you sent.

Reach any call of the team by its `_id`, whatever made it: the lemlist dialer, Aircall, Ringover or this API. A call logged through [`POST /calls`](https://developer.lemlist.com/api-reference/endpoints/calls/log-call) is also reached by the `externalId` you sent; the other calls have none (`externalId: null`) and show the dialer that made them in `phoneProvider`.

Read a call back when you need to know whether its recording landed (`hasRecording`), what status and note it holds now, or when a `POST` answered nothing (a timeout, a network error): the call is stored under your `externalId` as soon as lemlist answered, and this reads it without logging it again.


## OpenAPI

````yaml get /calls/{id}
openapi: 3.0.0
info:
  title: lemlist API
  version: 1.0.0
  description: >-
    Welcome to the lemlist Developer Documentation.


    lemlist is very customizable and open. You'll find on this page all the API
    and integration you can do with lemlist.


    # Rate Limit


    lemlist's API rate limits requests in order to prevent abuse and overload of
    our services.  

    Rate limits are applied on all routes and per API key performing the
    request.  

    The rate limits are **20** requests per **2** seconds.  

    The response provides any information you may need about it:


    | Header | Description |

    | --- | --- |

    | Retry-After | The number of seconds in which you can retry |

    | X-RateLimit-Limit | The maximum requests in that time |

    | X-RateLimit-Remaining | The number of remaining requests you can make |

    | X-RateLimit-Reset | The date when the rate limit will reset |


    _Example of values for the rate limit headers_


    ``` json

    {
        "Retry-After": 2,
        "X-RateLimit-Limit": 20,
        "X-RateLimit-Remaining": 7,
        "X-RateLimit-Reset" : "Tue Feb 16 2021 09:02:42 GMT+0100 (Central European Standard Time)"
    }

     ```

    # Definitions


    ## Team


    A team is the entity of lemlist that can handle users and billing.


    ## Credits


    Credits are the coins a team uses to enrich emails, LinkedIn URLs, etc. via
    the enrich route. Each enrichment feature needs a certain amount of credits
    to run.


    ## User


    You use a user account to connect to lemlist and send messages via the
    connected emails or LinkedIn account.


    ## Campaign


    A campaign is the entity to automate outreach. A campaign has multiple
    sequences composed of steps.


    ## Lead


    A lead is a person that you try to contact via a campaign.


    ## Activity


    An activity is the history of all the steps.


    ## Unsubscribe


    An unsubscribe occurs when a person decides they don't want to receive
    emails from you anymore.


    # Authentication


    All API routes use the dedicated subdomain `api.lemlist.com`.


    lemlist uses API keys to allow access to the API. You can get your lemlist
    API key at our [integration
    page](https://app.lemlist.com/settings/integrations).


    You need to add the `Authorization` header using the `Basic` authentication
    type. `login:password` **where the login is always empty and the password is
    the API key**.


    ⚠️ **Don't forget to add the semicolon (**`:`**) before your API key in curl
    command.**


    > To authorize, use this code: 
      

    ``` shell

    curl https://api.lemlist.com/api/team \
      --user ":YourApiKey"

     ```

    **Make sure to replace** **`YourApiKey`** **with your API key.**


    # Give feedback


    If you want to report a bug, ask for data, or share with us a use case,
    please fill this [form](https://lemlist.typeform.com/to/mfVlkyGf). It will
    help us centralize your needs!
servers:
  - url: https://api.lemlist.com/api
security:
  - basicAuth: []
tags:
  - name: Enrichment Providers
    description: >-
      The data providers lemlist can call to find an email or a phone.


      Internal providers are paid with lemlist credits and always available.
      External providers run on your own account: connect one by saving its API
      key, and it becomes available to your waterfalls. `GET
      /enrichments/providers` is the catalog of provider ids accepted by the
      waterfall endpoints.
  - name: Enrichment Waterfalls
    description: >-
      Control which data providers lemlist calls when enriching a contact, and
      in which order.


      A waterfall is an ordered list of providers for one enrichment `type`
      (`email` or `phone`). Providers are tried one after the other until one
      returns a result.


      Every team has exactly one default waterfall per type (`isDefault: true`).
      While its `editor` is `lemlist` it follows the lemlist behaviour:
      providers you connected with your own API key are tried first, then
      internal providers in a random order. Once a team member edits its
      provider list, `editor` becomes that user's id and the list is followed as
      is; resetting it hands it back to `lemlist`.


      Custom waterfalls (`isDefault: false`) carry `conditions` on the contact
      being enriched, keyed by contact property; every key present must match.
      When a contact is enriched, lemlist runs a single waterfall: the custom
      waterfall of the requested type whose conditions match the contact, or the
      default waterfall when none does. If several match, the one with the most
      condition keys wins, then the most recently updated. Only that waterfall
      runs; when it finds nothing, the enrichment ends without falling back to
      another one.
paths:
  /calls/{id}:
    get:
      tags:
        - Calls
      summary: Get a Call
      description: >-
        Reads a call of the team back: any call by its `_id`, whatever dialer
        made it (the lemlist dialer, Aircall, Ringover or this API), or a call
        logged through `POST /calls` by the `externalId` you sent. What a dialer
        reads to know whether the recording landed (`hasRecording`), the status
        and note as stored, or to recover the answer of a log it lost.
      parameters:
        - name: id
          in: path
          required: true
          description: The call's `_id` (`act_…`) or its `externalId`.
          example: trellus-8f2c1
          schema:
            type: string
      responses:
        '200':
          description: >-
            The call as stored. `hasRecording` turns `true` once the recording
            sent with `PATCH` is stored, a moment later.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/Call'
              example:
                success: true
                data:
                  _id: act_Z8gP3xYq2bKd9mLn7
                  externalId: trellus-8f2c1
                  contactId: ctc_7Ks2PqW9mXb4Lc1Td
                  leadId: lea_2Hn8VbQ4wRz6Ym3Jk
                  campaignId: cam_5Fd9LpX2cVt7Nq8Wb
                  taskId: opp_9Xw4RtY7kLm2Pq6Zc
                  userId: usr_3Bv7GhT5nJk8Lm2Qx
                  direction: outbound
                  from: '+33100000000'
                  to: '+33612345678'
                  startedAt: '2026-10-21T09:30:00.000Z'
                  endedAt: '2026-10-21T09:30:45.000Z'
                  duration: 45
                  callStatus: left-voicemail
                  note: Left a voicemail, call back Thursday.
                  phoneProvider: api
                  provider: trellus
                  hasRecording: true
                  hasTranscript: true
                  createdAt: '2026-10-21T09:30:00.000Z'
        '400':
          description: >-
            The `{id}` is refused: malformed, or neither a call id (`act_…`) nor
            an `externalId`.
          content:
            application/json:
              example:
                success: false
                error:
                  code: VALIDATION_ERROR
                  message: 'Match error: Expected a valid id'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: Unauthorized
        '402':
          description: >-
            The team's plan does not include the calls API (Email Pro and
            above).
        '404':
          description: >-
            No call of the team matches `{id}`: by `_id` any call, by
            `externalId` a call logged through the API.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: 'Error code: `CALLS_CALL_NOT_FOUND`.'
                      message:
                        type: string
              examples:
                calls-call-not-found:
                  summary: No call of the team matches
                  value:
                    success: false
                    error:
                      code: CALLS_CALL_NOT_FOUND
                      message: Call not found.
        '405':
          description: >-
            Method not allowed: this path accepts GET and PATCH. The body is the
            plain `{ "error": "Route bad method" }`.
          content:
            application/json:
              example:
                error: Route bad method
        '500':
          description: Unexpected failure, alerted to lemlist. Read again.
          content:
            application/json:
              example:
                success: false
                error:
                  code: INTERNAL_ERROR
                  message: Internal error
components:
  schemas:
    Call:
      type: object
      description: A call logged through `POST /calls`, as the calls API returns it.
      properties:
        _id:
          type: string
          description: >-
            The call's activity id, which `PATCH /calls/{id}` and `DELETE
            /activities/{activityId}/recording-transcript` take.
          example: act_Z8gP3xYq2bKd9mLn7
        externalId:
          type: string
          nullable: true
          description: >-
            Your own id of the call, as sent; `null` on a call another dialer
            made.
          example: trellus-8f2c1
        contactId:
          type: string
          nullable: true
          example: ctc_7Ks2PqW9mXb4Lc1Td
        leadId:
          type: string
          nullable: true
          description: The lead the call attached to, when it belongs to a campaign.
          example: lea_2Hn8VbQ4wRz6Ym3Jk
        campaignId:
          type: string
          nullable: true
          example: cam_5Fd9LpX2cVt7Nq8Wb
        taskId:
          type: string
          nullable: true
          description: The call task the call completed.
          example: opp_9Xw4RtY7kLm2Pq6Zc
        userId:
          type: string
          nullable: true
          description: The rep the call is attributed to.
          example: usr_3Bv7GhT5nJk8Lm2Qx
        direction:
          type: string
          nullable: true
          enum:
            - inbound
            - outbound
          example: outbound
        from:
          type: string
          nullable: true
          description: >-
            The caller's number: the rep's line on an outbound call, the
            contact's on an inbound one.
          example: '+33100000000'
        to:
          type: string
          nullable: true
          description: The number called.
          example: '+33612345678'
        startedAt:
          type: string
          format: date-time
          nullable: true
          example: '2026-10-21T09:30:00.000Z'
        endedAt:
          type: string
          format: date-time
          nullable: true
          description: '`startedAt` plus `duration`; absent without a duration.'
          example: '2026-10-21T09:31:30.000Z'
        duration:
          type: integer
          nullable: true
          description: Seconds.
          example: 90
        callStatus:
          type: string
          nullable: true
          description: The key of the call status set on the call.
          example: connected-positive
        note:
          type: string
          nullable: true
          example: Asked for a demo next week.
        phoneProvider:
          type: string
          nullable: true
          description: >-
            `api` for a call logged through this API; the dialer that made it
            otherwise (`twilio` for the lemlist dialer, `aircall`, `ringover`)
            on a call read back by `_id`.
          example: api
        provider:
          type: string
          nullable: true
          description: >-
            The dialer's name a call was logged with through this API
            (`provider`), lowercase; `null` when none was sent and on any other
            call.
          example: trellus
        hasRecording:
          type: boolean
          description: >-
            True once the call has a recording in lemlist: a `recordingUrl` just
            sent is still on its way.
          example: false
        hasTranscript:
          type: boolean
          example: true
        createdAt:
          type: string
          format: date-time
          nullable: true
          description: 'The call''s time in lemlist: `startedAt`.'
          example: '2026-10-21T09:30:00.000Z'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

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