List addresses in a domain

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}

Close
GET /local-emails/{caseId}/domains/{domain}/addresses

Lists the email addresses of one domain that appear in the case's emails, with how many emails each appears in.

Path parameters

  • caseId string Required
  • domain string Required

Query parameters

  • page number

    Default value is 1.

  • perPage number

    Default value is 10.

  • skip number

    If skip/limit not provided, page/perPage will take precedence

  • limit number

    If skip/limit not provided, page/perPage will take precedence

  • sourceEmails array[string]

    Restrict to these source mailboxes (provider emails). Omit to cover every mailbox in the case.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • addresses array[object] Required
        Hide addresses attributes Show addresses attributes object
        • email string Required

          A participant email address of the domain, lowercased.

        • count number Required

          Number of emails (documents) containing this address in from/to/cc/bcc.

      • total number Required

        Distinct addresses in the domain (for pagination). Note: the sum of per-address counts may exceed the domain document count, since one email can contain multiple addresses of the same domain.

      • page number
      • perPage number
      • skip number Required
      • limit number Required
    • statusCode number Required
    • timestamp string(date-time) Required
GET /local-emails/{caseId}/domains/{domain}/addresses
curl \
 --request GET 'http://api.example.com/local-emails/{caseId}/domains/{domain}/addresses' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "data": {
    "addresses": [
      {
        "email": "john.roe@example.org",
        "count": 42
      }
    ],
    "total": 5,
    "page": 1,
    "perPage": 20,
    "skip": 0,
    "limit": 20
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}