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

# Companies to act on now, each with the person to approach

> The account's companies by score, highest first, straight from the stored scores (updated in real time on every signal and faded nightly). AI assistants and shared-network traffic are never scored. `tier` starts at hot, warm, cool or cold and fills up to `limit` from the tiers below; `meta.in_tier` tells how many came from the tier asked for. `relationship` defaults to prospects (not in a connected CRM, not tagged customer, competitor or not-interesting). Each row has the pillars, the 7-day change, the strongest reasons and the person to approach as scoring ranked them; fetch names and email addresses through the contact endpoints. The website identified the company, not a contact from the contact database: never imply that person visited.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/trackers/{tracker_code}/opportunities
openapi: 3.1.0
info:
  title: Leadinfo Data API
  version: 0.1.0
  x-logo:
    url: https://asset.leadinfo.com/assets/email_logo.png
servers:
  - url: https://data.leadinfo.com
    description: Production
security: []
paths:
  /v1/trackers/{tracker_code}/opportunities:
    get:
      tags:
        - traffic
      summary: Companies to act on now, each with the person to approach
      description: >-
        The account's companies by score, highest first, straight from the
        stored scores (updated in real time on every signal and faded nightly).
        AI assistants and shared-network traffic are never scored. `tier` starts
        at hot, warm, cool or cold and fills up to `limit` from the tiers below;
        `meta.in_tier` tells how many came from the tier asked for.
        `relationship` defaults to prospects (not in a connected CRM, not tagged
        customer, competitor or not-interesting). Each row has the pillars, the
        7-day change, the strongest reasons and the person to approach as
        scoring ranked them; fetch names and email addresses through the contact
        endpoints. The website identified the company, not a contact from the
        contact database: never imply that person visited.
      operationId: list_opportunities_v1_trackers__tracker_code__opportunities_get
      parameters:
        - name: tracker_code
          in: path
          required: true
          schema:
            type: string
            title: Tracker Code
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            maximum: 1000
            minimum: 0
            default: 0
            title: Offset
        - name: tier
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                enum:
                  - hot
                  - warm
                  - cool
                  - cold
              - type: 'null'
            title: Tier
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 20
            title: Limit
        - name: relationship
          in: query
          required: false
          schema:
            enum:
              - all
              - prospects
              - existing
            type: string
            default: prospects
            title: Relationship
        - name: icp_only
          in: query
          required: false
          schema:
            type: boolean
            default: false
            title: Icp Only
        - name: persona_id
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            title: Persona Id
        - name: exclude_tag_ids
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Exclude Tag Ids
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunitiesResponse'
        '401':
          description: Invalid credentials.
        '403':
          description: Tracker not owned by this client.
        '404':
          description: No stored scores for this account yet.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    OpportunitiesResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Opportunity'
          type: array
          title: Data
        meta:
          $ref: '#/components/schemas/OpportunitiesMeta'
      type: object
      required:
        - data
        - meta
      title: OpportunitiesResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Opportunity:
      properties:
        company_id:
          type: integer
          title: Company Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
        score:
          type: integer
          title: Score
        tier:
          type: string
          enum:
            - hot
            - warm
            - cool
            - cold
          title: Tier
          description: hot 70 and up, warm 50 to 69, cool 30 to 49, cold below 30
        pillars:
          $ref: '#/components/schemas/OpportunityPillars'
        delta_7d:
          anyOf:
            - type: integer
            - type: 'null'
          title: Delta 7D
          description: Score change over the last 7 days; empty when it did not move.
        reasons:
          items:
            type: string
          type: array
          title: Reasons
          description: 'Why it scores: the strongest line of its strongest pillars.'
        contact:
          anyOf:
            - $ref: '#/components/schemas/OpportunityContact'
            - type: 'null'
        in_crm:
          type: boolean
          title: In Crm
          default: false
        tag_ids:
          items:
            type: integer
          type: array
          title: Tag Ids
        as_of:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: As Of
          description: Day the score refers to
      type: object
      required:
        - company_id
        - score
        - tier
        - pillars
      title: Opportunity
    OpportunitiesMeta:
      properties:
        total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total
        has_more:
          type: boolean
          title: Has More
          default: false
        returned:
          type: integer
          title: Returned
        limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Limit
        offset:
          type: integer
          title: Offset
          default: 0
        next_offset:
          anyOf:
            - type: integer
            - type: 'null'
          title: Next Offset
          description: The offset of the next page; null on the last page.
        tier:
          anyOf:
            - type: string
              enum:
                - hot
                - warm
                - cool
                - cold
            - type: 'null'
          title: Tier
          description: The tier asked for; lower tiers fill up to limit.
        in_tier:
          anyOf:
            - type: integer
            - type: 'null'
          title: In Tier
          description: Rows from the tier asked for.
        tiers:
          additionalProperties:
            type: integer
          type: object
          title: Tiers
          description: Returned rows per tier.
        scored_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Scored At
        scoring_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Scoring Version
      type: object
      required:
        - returned
      title: OpportunitiesMeta
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    OpportunityPillars:
      properties:
        fit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Fit
        intent:
          anyOf:
            - type: integer
            - type: 'null'
          title: Intent
        engagement:
          anyOf:
            - type: integer
            - type: 'null'
          title: Engagement
        people:
          anyOf:
            - type: integer
            - type: 'null'
          title: People
      type: object
      title: OpportunityPillars
    OpportunityContact:
      properties:
        reason:
          type: string
          enum:
            - persona_engaged
            - persona_identified
            - persona_in_database
            - senior_in_database
          title: Reason
          description: >-
            persona_engaged: a persona match acted (e.g. replied to an email);
            persona_identified: a persona match was identified on your website;
            persona_in_database: the most senior persona match in the contact
            database; senior_in_database: no persona matches (or none are set
            up), the most senior contact at the company. Contacts from the
            database have not visited.
        source:
          type: string
          enum:
            - lead_contact
            - visitor
            - database
          title: Source
          description: >-
            lead_contact: a contact in your Leads (contact_id is its Leads id);
            visitor: an identified website visitor; database: the contact
            database (contact_id).
        contact_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact Id
        job_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Job Title
        persona:
          anyOf:
            - type: string
            - type: 'null'
          title: Persona
          description: Persona Builder persona
        via:
          anyOf:
            - type: string
            - type: 'null'
          title: Via
          description: The signal, for people who acted
        at:
          anyOf:
            - type: string
            - type: 'null'
          title: At
          description: When they acted or visited
        contacts:
          anyOf:
            - type: integer
            - type: 'null'
          title: Contacts
          description: >-
            From the contact database: how many contacts (of that persona) it
            has at the company
      type: object
      required:
        - reason
        - source
      title: OpportunityContact
      description: >-
        The person to approach: the first evidence of the company's people
        pillar, as

        scoring ranked it. Identifiers only: names and email addresses come from
        the

        contact or Leads endpoints.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

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