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

# List sending mailboxes

> Whose mailbox can send, and whose has gone stale.

Nothing leaves without one, so "why is nothing being sent" is usually
answered here.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/public/outreach/mailboxes
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/mailboxes:
    get:
      tags:
        - Outreach
      summary: List sending mailboxes
      description: |-
        Whose mailbox can send, and whose has gone stale.

        Nothing leaves without one, so "why is nothing being sent" is usually
        answered here.
      operationId: outreach_mailboxes_api_v1_public_outreach_mailboxes_get
      parameters:
        - 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/OutreachSiteMailboxesResponse'
        '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:
    OutreachSiteMailboxesResponse:
      properties:
        mailboxes:
          items:
            $ref: '#/components/schemas/OutreachMailboxStatus'
          type: array
          title: Mailboxes
        limit:
          type: integer
          title: Limit
          default: 0
        attached_count:
          type: integer
          title: Attached Count
          default: 0
      type: object
      required:
        - mailboxes
      title: OutreachSiteMailboxesResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    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
    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
  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.