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

# Get outreach home

> Everything the Outreach home shows, counted once.

The three things waiting on a person, the results, what the agent is doing
right now, the tab counts and the first page of rows, all from one
grouping. An agent asked "what needs me" answers from this.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/public/outreach/home
openapi: 3.1.0
info:
  title: Hikoo REST API
  description: >-
    Programmatic access to your Hikoo data: AI citations, prompts, topics,
    competitors, sources, audits, site health, indexation, AI-crawler traffic,
    and outreach. Authenticate with a personal API key sent as `Authorization:
    Bearer <key>`. Create one in the dashboard under **Settings > API keys**.
  version: 1.0.0
servers:
  - url: https://api.tryhikoo.com
    description: Production
security:
  - apiKey: []
tags:
  - name: Account
    description: The user behind the API key.
  - name: Workspaces
    description: >-
      Workspaces the user belongs to. Use them to find the websites you can
      query.
  - name: Websites
    description: Every website the user can access, with its subscription status.
  - name: Website
    description: Metadata and plan of one website.
  - name: Citations
    description: >-
      Every time an AI assistant answers one of your prompts, Hikoo stores the
      answer as a citation. These endpoints list them and aggregate them by
      platform, source, sentiment and match type.
  - name: Prompts
    description: >-
      Prompts are the questions Hikoo sends to AI assistants for a website.
      Create, edit, archive and restore them, and read their visibility, answers
      and citations.
  - name: Topics
    description: Topics group prompts. Every prompt belongs to one topic.
  - name: Search queries
    description: >-
      The web searches AI assistants run internally (query fan-out) before
      answering your prompts.
  - name: URL lookup
    description: >-
      Where one URL shows up, across AI-cited sources and AI-crawler traffic, in
      one call.
  - name: Competitors
    description: >-
      Tracked competitors, their share of voice, and the competitor suggestions
      Hikoo detects in AI answers.
  - name: Source intelligence
    description: >-
      The domains and pages AI assistants cite for your prompts, and who appears
      on them.
  - name: Audits
    description: GEO audits of a full site, a list of pages or a single URL.
  - name: Health
    description: >-
      Site-level checks for AI readiness (robots.txt, llms.txt, sitemap) and
      improvement suggestions.
  - name: Indexation
    description: >-
      The pages Hikoo crawled on your website, their category, health and
      errors.
  - name: Content gaps
    description: >-
      Topics where AI assistants answer without citing you, with a content brief
      for each.
  - name: Agent analytics
    description: Traffic from AI crawlers and AI agents on your website.
  - name: Outreach
    description: >-
      The outreach agent: sources worth getting cited on, their contacts, the
      pitches waiting for approval, follow-ups, and what the agent is allowed to
      do on its own.
paths:
  /api/v1/public/outreach/home:
    get:
      tags:
        - Outreach
      summary: Get outreach home
      description: >-
        Everything the Outreach home shows, counted once.


        The three things waiting on a person, the results, what the agent is
        doing

        right now, the tab counts and the first page of rows, all from one

        grouping. An agent asked "what needs me" answers from this.
      operationId: outreach_home_api_v1_public_outreach_home_get
      parameters:
        - name: tab
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Tab
        - name: outcome
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Outcome
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 120
              - type: 'null'
            title: Search
        - name: website_id
          in: query
          required: true
          schema:
            type: integer
            description: Target website id
            title: Website Id
          description: Target website id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutreachHomeResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    OutreachHomeResponse:
      properties:
        send_disabled:
          type: boolean
          title: Send Disabled
          default: false
        decisions_waiting:
          anyOf:
            - type: object
            - type: 'null'
          title: Decisions Waiting
        tabs:
          $ref: '#/components/schemas/OutreachHomeTabs'
        outcomes:
          $ref: '#/components/schemas/OutreachHomeOutcomes'
        actions:
          $ref: '#/components/schemas/OutreachHomeActions'
        results:
          $ref: '#/components/schemas/OutreachHomeResults'
        agent_now:
          $ref: '#/components/schemas/OutreachAgentLine'
        agent_next:
          $ref: '#/components/schemas/OutreachAgentLine'
        contact_allowance:
          $ref: '#/components/schemas/OutreachContactAllowance'
        mailbox:
          $ref: '#/components/schemas/OutreachHomeMailbox'
        rows:
          items:
            $ref: '#/components/schemas/OutreachSourceListItem'
          type: array
          title: Rows
          default: []
        total:
          type: integer
          title: Total
          default: 0
        agent_mode:
          type: boolean
          title: Agent Mode
          default: false
        told_after:
          anyOf:
            - $ref: '#/components/schemas/OutreachToldAfter'
            - type: 'null'
      type: object
      required:
        - tabs
        - outcomes
        - actions
        - results
        - agent_now
        - agent_next
        - contact_allowance
        - mailbox
      title: OutreachHomeResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OutreachHomeTabs:
      properties:
        active:
          type: integer
          title: Active
          default: 0
        needs_you:
          type: integer
          title: Needs You
          default: 0
        hikoo_working:
          type: integer
          title: Hikoo Working
          default: 0
        waiting:
          type: integer
          title: Waiting
          default: 0
        closed:
          type: integer
          title: Closed
          default: 0
        in_progress:
          type: integer
          title: In Progress
          default: 0
      type: object
      title: OutreachHomeTabs
    OutreachHomeOutcomes:
      properties:
        won:
          type: integer
          title: Won
          default: 0
        lost:
          type: integer
          title: Lost
          default: 0
        disqualified:
          type: integer
          title: Disqualified
          default: 0
      type: object
      title: OutreachHomeOutcomes
    OutreachHomeActions:
      properties:
        hot_replies:
          $ref: '#/components/schemas/OutreachActionRow'
        pitches_to_approve:
          $ref: '#/components/schemas/OutreachActionRow'
        follow_ups_to_approve:
          $ref: '#/components/schemas/OutreachActionRow'
          default:
            count: 0
            going_cold: false
        replies_to_approve:
          $ref: '#/components/schemas/OutreachActionRow'
          default:
            count: 0
            going_cold: false
      type: object
      required:
        - hot_replies
        - pitches_to_approve
      title: OutreachHomeActions
    OutreachHomeResults:
      properties:
        mentions_won:
          type: integer
          title: Mentions Won
          default: 0
        active_opportunities:
          type: integer
          title: Active Opportunities
          default: 0
        pitched:
          type: integer
          title: Pitched
          default: 0
        replies:
          type: integer
          title: Replies
          default: 0
        reply_rate:
          type: number
          title: Reply Rate
          default: 0
        sources_analysed:
          type: integer
          title: Sources Analysed
          default: 0
        sources_kept:
          type: integer
          title: Sources Kept
          default: 0
        agreed_not_live:
          type: integer
          title: Agreed Not Live
          default: 0
      type: object
      title: OutreachHomeResults
    OutreachAgentLine:
      properties:
        key:
          anyOf:
            - $ref: '#/components/schemas/OutreachAgentNow'
            - $ref: '#/components/schemas/OutreachAgentNext'
          title: Key
        params:
          type: object
          title: Params
          default: {}
      type: object
      required:
        - key
      title: OutreachAgentLine
    OutreachContactAllowance:
      properties:
        used:
          type: integer
          title: Used
        cap:
          type: integer
          title: Cap
        reached:
          type: boolean
          title: Reached
        resumes_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Resumes At
        waiting:
          type: integer
          title: Waiting
          default: 0
      type: object
      required:
        - used
        - cap
        - reached
      title: OutreachContactAllowance
    OutreachHomeMailbox:
      properties:
        any_connected:
          type: boolean
          title: Any Connected
          default: false
        sending_for_site:
          type: boolean
          title: Sending For Site
          default: false
        mine_connected:
          type: boolean
          title: Mine Connected
          default: false
        needs_reconnect:
          items:
            type: string
          type: array
          title: Needs Reconnect
          default: []
        mailboxes:
          items:
            $ref: '#/components/schemas/OutreachMailboxStatus'
          type: array
          title: Mailboxes
          default: []
      type: object
      title: OutreachHomeMailbox
    OutreachSourceListItem:
      properties:
        id:
          type: integer
          title: Id
        domain:
          type: string
          title: Domain
        status:
          $ref: '#/components/schemas/OutreachStatus'
        status_set_by:
          $ref: '#/components/schemas/OutreachActor'
        status_updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Status Updated At
        priority:
          type: number
          title: Priority
          default: 0
        priority_factors:
          items:
            $ref: '#/components/schemas/OutreachPriorityFactor'
          type: array
          title: Priority Factors
          default: []
        language:
          anyOf:
            - type: string
            - type: 'null'
          title: Language
        blocked_reason:
          anyOf:
            - $ref: '#/components/schemas/OutreachRejectReason'
            - $ref: '#/components/schemas/OutreachBlockedReason'
            - type: 'null'
          title: Blocked Reason
        snooze_until:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Snooze Until
        next_resolution_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Next Resolution At
        owner_user_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Owner User Id
        owner_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Owner Name
        first_contacted_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: First Contacted At
        last_activity_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Activity At
        followup_count:
          type: integer
          title: Followup Count
          default: 0
        needs_decision:
          type: boolean
          title: Needs Decision
          default: false
        close:
          anyOf:
            - type: object
            - type: 'null'
          title: Close
        deal_terms:
          anyOf:
            - type: object
            - type: 'null'
          title: Deal Terms
        exchange:
          anyOf:
            - type: object
            - type: 'null'
          title: Exchange
        decision:
          anyOf:
            - type: object
            - type: 'null'
          title: Decision
        follow_up_blocked:
          anyOf:
            - type: string
            - type: 'null'
          title: Follow Up Blocked
        primary_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Primary Url
        primary_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Primary Title
        url_count:
          type: integer
          title: Url Count
          default: 0
        citation_count:
          type: integer
          title: Citation Count
          default: 0
        platforms:
          items:
            type: string
          type: array
          title: Platforms
          default: []
        contact:
          anyOf:
            - $ref: '#/components/schemas/OutreachContactResponse'
            - type: 'null'
        prior_contact_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Prior Contact At
        prior_contact_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Prior Contact Email
        prior_contact_replied:
          type: boolean
          title: Prior Contact Replied
          default: false
        stage:
          $ref: '#/components/schemas/OutreachStage'
          default: hikoo_working
        outcome:
          anyOf:
            - $ref: '#/components/schemas/OutreachOutcome'
            - type: 'null'
        stage_detail:
          $ref: '#/components/schemas/OutreachStageDetail'
          default: qualifying
        stage_detail_params:
          type: object
          title: Stage Detail Params
          default: {}
        waiting_days:
          anyOf:
            - type: integer
            - type: 'null'
          title: Waiting Days
        next_follow_up_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Next Follow Up At
        closed_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Closed Reason
        with_you_until:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: With You Until
        paused_until:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Paused Until
        next_step:
          anyOf:
            - $ref: '#/components/schemas/OutreachNextStep'
            - type: 'null'
        close_reason:
          anyOf:
            - $ref: '#/components/schemas/OutreachCloseReason'
            - type: 'null'
      type: object
      required:
        - id
        - domain
        - status
        - status_set_by
      title: OutreachSourceListItem
    OutreachToldAfter:
      properties:
        count:
          type: integer
          title: Count
          default: 0
        since:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Since
        items:
          items:
            $ref: '#/components/schemas/OutreachToldAfterItem'
          type: array
          title: Items
          default: []
      type: object
      title: OutreachToldAfter
    Error:
      type: object
      title: Error
      required:
        - detail
      properties:
        detail:
          type: string
          description: Human-readable explanation of the error.
    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
    OutreachActionRow:
      properties:
        count:
          type: integer
          title: Count
          default: 0
        first_source_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: First Source Id
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        days_waiting:
          anyOf:
            - type: integer
            - type: 'null'
          title: Days Waiting
        going_cold:
          type: boolean
          title: Going Cold
          default: false
      type: object
      title: OutreachActionRow
    OutreachAgentNow:
      type: string
      enum:
        - writing_pitches
        - reading_replies
        - finding_contacts
        - qualifying
        - reading_sources
        - idle
      title: OutreachAgentNow
    OutreachAgentNext:
      type: string
      enum:
        - send_on_approval
        - send_when_mailbox_connected
        - send_scheduled
        - follow_up
        - next_check
        - nothing_planned
      title: OutreachAgentNext
    OutreachMailboxStatus:
      properties:
        user_id:
          type: integer
          title: User Id
        user_email:
          type: string
          title: User Email
        user_name:
          anyOf:
            - type: string
            - type: 'null'
          title: User Name
        connected:
          type: boolean
          title: Connected
        provider:
          anyOf:
            - $ref: '#/components/schemas/OutreachMailboxProvider'
            - type: 'null'
        google_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Google Email
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
        is_active:
          type: boolean
          title: Is Active
          default: false
        paused:
          type: boolean
          title: Paused
          default: false
        signature_role:
          anyOf:
            - type: string
            - type: 'null'
          title: Signature Role
        signature_block:
          anyOf:
            - type: string
            - type: 'null'
          title: Signature Block
        timezone:
          anyOf:
            - type: string
            - type: 'null'
          title: Timezone
        attached:
          type: boolean
          title: Attached
          default: false
        state:
          anyOf:
            - $ref: '#/components/schemas/OutreachMailboxSiteState'
            - type: 'null'
        sends_for_site:
          type: boolean
          title: Sends For Site
          default: false
        daily_cap:
          anyOf:
            - type: integer
            - type: 'null'
          title: Daily Cap
        warmup_until:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Warmup Until
        paused_until:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Paused Until
        paused_reason:
          anyOf:
            - $ref: '#/components/schemas/OutreachMailboxPauseReason'
            - type: 'null'
      type: object
      required:
        - user_id
        - user_email
        - connected
      title: OutreachMailboxStatus
    OutreachStatus:
      type: string
      enum:
        - eligible
        - rejected
        - contact_pending
        - contact_unresolved
        - draft_ready
        - awaiting_approval
        - contacted
        - replied
        - needs_human
        - in_discussion
        - no_reply
        - declined
        - placed
        - stopped
        - blacklisted
        - snoozed
      title: OutreachStatus
    OutreachActor:
      type: string
      enum:
        - agent
        - user
      title: OutreachActor
    OutreachPriorityFactor:
      properties:
        key:
          type: string
          title: Key
        points:
          type: integer
          title: Points
        max:
          type: integer
          title: Max
      type: object
      required:
        - key
        - points
        - max
      title: OutreachPriorityFactor
    OutreachRejectReason:
      type: string
      enum:
        - own_domain
        - competitor
        - suggested_competitor
        - major_platform
        - directory
        - already_mentioned
        - not_actionable
        - blacklisted
        - recently_contacted
        - no_usable_url
        - outside_si_window
        - not_relevant
        - page_gone
        - refused_in_workspace
        - rival_vendor
        - below_citation_floor
        - listed_nothing_to_correct
        - listed_only_generic_asks
        - page_unreachable
        - draft_breaks_rules
        - not_selected_by_triage
        - page_blocked
        - page_no_text
        - test_based_no_offer
        - review_aggregator
        - head_to_head_comparison
        - single_product_review
        - language_unsupported
        - category_mismatch
        - market_mismatch
        - follow_up_limit
        - no_answerable_criterion
        - stale_page
        - vendor_page
        - sponsored_page
        - agent_not_fit
      title: OutreachRejectReason
    OutreachBlockedReason:
      type: string
      enum:
        - fetch_failed
        - no_named_person
        - no_target_url
        - no_address
        - no_email
        - generic_address
        - solo_inbox
        - low_confidence
        - missing_full_name
        - address_inferred
        - address_from_provider
        - address_off_domain
        - email_unknown
        - email_risky
        - email_invalid
        - unresolved
        - stopped_citing
        - delivery_refused
      title: OutreachBlockedReason
    OutreachContactResponse:
      properties:
        id:
          type: integer
          title: Id
        is_alternate:
          type: boolean
          title: Is Alternate
          default: false
        full_name:
          type: string
          title: Full Name
        role_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Role Title
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        linkedin_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Linkedin Url
        confidence:
          type: number
          title: Confidence
          default: 0
        email_verified:
          type: boolean
          title: Email Verified
          default: false
        verification_result:
          $ref: '#/components/schemas/OutreachEmailVerification'
          default: unknown
        is_generic:
          type: boolean
          title: Is Generic
          default: false
        job_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Job Title
      type: object
      required:
        - id
        - full_name
      title: OutreachContactResponse
    OutreachStage:
      type: string
      enum:
        - needs_you
        - hikoo_working
        - waiting
        - closed
      title: OutreachStage
    OutreachOutcome:
      type: string
      enum:
        - won
        - lost
        - disqualified
      title: OutreachOutcome
    OutreachStageDetail:
      type: string
      enum:
        - hot_reply_money
        - hot_reply
        - delivery_refused
        - taken_by_you
        - approve_pitch
        - approve_reply
        - approve_follow_up
        - decision
        - qualifying
        - finding_person
        - writing_pitch
        - waiting_to_search
        - waiting_to_write
        - contact_quota_reached
        - waiting_reply
        - follow_up_due
        - followed_up
        - waiting_to_connect
        - in_discussion
        - snoozed
        - awaiting_publication
        - with_you_until
        - paused_until
        - queued_to_send
        - no_person_yet
        - no_person_last_look
        - mention_online
        - they_declined
        - lost_paid_only
        - do_not_contact
        - no_reply
        - you_stopped
        - disqualified
      title: OutreachStageDetail
    OutreachNextStep:
      properties:
        who:
          $ref: '#/components/schemas/OutreachNextActor'
        what:
          type: string
          title: What
        params:
          type: object
          title: Params
          default: {}
      type: object
      required:
        - who
        - what
      title: OutreachNextStep
    OutreachCloseReason:
      properties:
        family:
          $ref: '#/components/schemas/OutreachCloseFamily'
        code:
          type: string
          title: Code
        by:
          $ref: '#/components/schemas/OutreachCloseBy'
        text:
          anyOf:
            - type: string
            - type: 'null'
          title: Text
        params:
          type: object
          title: Params
          default: {}
      type: object
      required:
        - family
        - code
        - by
      title: OutreachCloseReason
    OutreachToldAfterItem:
      properties:
        id:
          type: integer
          title: Id
        source_id:
          type: integer
          title: Source Id
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        payload:
          type: object
          title: Payload
          default: {}
        occurred_at:
          type: string
          format: date-time
          title: Occurred At
      type: object
      required:
        - id
        - source_id
        - occurred_at
      title: OutreachToldAfterItem
    OutreachMailboxProvider:
      type: string
      enum:
        - google
        - microsoft
      title: OutreachMailboxProvider
    OutreachMailboxSiteState:
      type: string
      enum:
        - sends
        - paused_by_plan
        - disconnected
        - not_attached
        - no_mailbox
      title: OutreachMailboxSiteState
    OutreachMailboxPauseReason:
      type: string
      enum:
        - reputation
        - provider_limit
      title: OutreachMailboxPauseReason
    OutreachEmailVerification:
      type: string
      enum:
        - valid
        - risky
        - invalid
        - unknown
      title: OutreachEmailVerification
    OutreachNextActor:
      type: string
      enum:
        - you
        - hikoo
        - them
        - nobody
      title: OutreachNextActor
    OutreachCloseFamily:
      type: string
      enum:
        - won
        - no_reply
        - declined
        - paid_only
        - do_not_contact
        - stopped_by_you
        - already_mentioned
        - not_a_fit
        - competitor
        - no_one_to_ask
        - page_unavailable
        - not_cited_enough
        - no_contact
        - out_of_scope
        - other
      title: OutreachCloseFamily
    OutreachCloseBy:
      type: string
      enum:
        - hikoo
        - you
        - them
      title: OutreachCloseBy
  responses:
    Unauthorized:
      description: >-
        The `Authorization` header is missing, malformed, or the key is invalid,
        expired or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: Invalid or expired API key
    Forbidden:
      description: >-
        The key is valid but not allowed to do this: the website has no active
        subscription, your role in the workspace is read-only for a write
        request, or your email is not verified.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: >-
              This website has no active subscription, so its data is
              unavailable.
      headers:
        X-Error-Code:
          description: >-
            Stable machine-readable error code, when one applies (for example
            `rate_limited`).
          schema:
            type: string
    NotFound:
      description: >-
        The website, or the resource in the path, does not exist or is not
        visible to this key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: Website not found
    RateLimited:
      description: >-
        Too many requests for this API key. Wait for the number of seconds in
        `Retry-After`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: Too many requests. Please try again shortly.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        X-Error-Code:
          description: >-
            Stable machine-readable error code, when one applies (for example
            `rate_limited`).
          schema:
            type: string
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Personal API key created in the dashboard under Settings > API keys.

````

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