> ## 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.

> Reads a contact-sourcing run by ID, or the latest run of an account.

# Get Contact Sourcing Run

Pass **either** `runId` (the ID returned when you started the run) **or**
`companyId` (to read that account's most recent run) — not both.

## The status is in the HTTP code

You can drive a polling loop from the status code alone, without parsing the
body:

| Code  | Meaning                                                             |
| ----- | ------------------------------------------------------------------- |
| `200` | The run finished. `contacts` holds the buying committee.            |
| `202` | The run is queued or still going. `contacts` is empty — poll again. |
| `400` | The run failed. `error` says why.                                   |
| `404` | No such run, or this account has never been sourced.                |

## Reading the result

Each entry in `contacts` is one person of the buying committee:

```json theme={"theme":"dracula"}
{
  "runId": "air_H2nQv7Bs4Jm1Ty8Wk",
  "companyId": "cpn_K4tRm2Qw9Yb7Xz1Ns",
  "status": "completed",
  "reasoning": "Sales-led org; the VP Sales owns tooling decisions.",
  "contacts": [
    {
      "leadId": "123456789",
      "role": "decision_maker",
      "fitScore": 92,
      "reasoning": "Owns the outbound budget and the tooling decision.",
      "fullName": "Jane Smith",
      "jobTitle": "VP Sales",
      "linkedinUrl": "https://www.linkedin.com/in/jane-smith",
      "country": "France",
      "companyName": "Acme"
    }
  ]
}
```

<Warning>
  `leadId` is a **People Database ID**, not a lemlist contact ID. Nobody has been
  added to your workspace yet — pass it to
  [Add a Sourced Contact](/api-reference/endpoints/contact-sourcing/add-sourced-contact)
  to create the contact.
</Warning>

`companyName` is the person's **current** employer, which is not always the
account that was classified: someone can match an account through a past role.


## OpenAPI

````yaml get /contact-sourcing
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: []
paths:
  /contact-sourcing:
    get:
      tags:
        - Contact sourcing
      summary: Get Contact Sourcing Run
      description: >-
        Reads one contact-sourcing run — by its own id, or the latest run of an
        account.


        The HTTP status carries the run state: `200` the run completed and
        `contacts` is filled, `202` the run is still queued or going (poll
        again), `400` the run failed and `error` says why, `404` no such run.


        Exactly one of `runId` or `companyId` is required.
      parameters:
        - name: runId
          in: query
          required: false
          description: The run to read, as returned by `POST /contact-sourcing`.
          schema:
            type: string
          example: air_H2nQv7Bs4Jm1Ty8Wk
        - name: companyId
          in: query
          required: false
          description: Read the LATEST run of this account instead (`cpn_xxx` format).
          schema:
            type: string
      responses:
        '200':
          description: The run completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactSourcingRun'
        '202':
          description: The run is queued or still going; `contacts` is empty.
        '400':
          description: The run failed; `error` says why.
        '404':
          description: No such run, or the account has never been sourced.
components:
  schemas:
    ContactSourcingRun:
      type: object
      properties:
        runId:
          type: string
        companyId:
          type: string
        status:
          type: string
          enum:
            - pending
            - running
            - completed
            - failed
        ranAt:
          type: string
          format: date-time
        completedAt:
          type: string
          format: date-time
        reasoning:
          type: string
          description: >-
            The AI's read-out of the account — why it picked these people, or
            found nobody.
        error:
          type: string
          description: Only on a failed run.
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/ContactSourcingContact'
    ContactSourcingContact:
      type: object
      properties:
        leadId:
          type: string
          description: >-
            People-Database id. Pass it to `POST /contact-sourcing/contacts` to
            add this person as a contact.
        role:
          type: string
          enum:
            - decision_maker
            - user
            - influencer
        fitScore:
          type: number
          description: How well the person matches the team's ICP, 0-100.
        reasoning:
          type: string
        fullName:
          type: string
        jobTitle:
          type: string
        linkedinUrl:
          type: string
        country:
          type: string
        companyName:
          type: string
          description: >-
            The person's CURRENT employer, which is not always the account
            classified.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````