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

• sortOrder string

  Values are asc or desc. Default value is asc.

• searchText string

  Text search applied to all indexed fields (subject, body, snippet, from/to/cc/bcc). Supports the same AND / OR / NOT / -prefix, parentheses, "quoted phrases" and wildcards as the boolean query parser.

• folders array[string]
• domains array[string]

  Filter by participant domain(s) (part after @), any-of. Case-insensitive. Requires the domains field on the emailtext Atlas index.

• excludeDomains array[string]

  Exclude items whose domain(s) match any of these (any-of). Case-insensitive. Must not overlap domains.

• tags array[string]
• excludeTags array[string]

  Exclude items carrying any of these tag ids. Must not overlap tags.

• untagged boolean

  When truthy (1/true), return only emails with no tags attached. Takes precedence over the tags filter.

• participants array[string]

  Filter by participant email address(es), any-of.

• excludeEmails array[string]

  Exclude items whose participant address matches any of these (any-of). Must not overlap participants.

• startDate string(date-time)

  Only return emails whose date is at/after this instant (inclusive). Accepts an ISO-8601 date-time.

• endDate string(date-time)

  Only return emails whose date is at/before this instant (inclusive). Accepts an ISO-8601 date-time.

• sourceEmails array[string]
• sortBy string

  Values are date or subject. Default value is date.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • data object Required
    Hide data attributes Show data attributes object

    • total number Required
    • page number
    • perPage number
    • skip number
    • limit number
    • totalPages number Required
    • nextPage number | null Required
    • previousPage number | null Required
    • data array[object]
      Hide data attributes Show data attributes object

      • createdAt string(date-time) Required
      • updatedAt string(date-time) Required
      • id string Required
      • emailDataProvider object | null Required

        Not loaded by any route, so always null.

      • sourceEmail string Required
      • body string | null Required
      • date string(date-time) | null Required
      • attachments array[object] | null Required

        The full record on routes that load it; null (or an empty list) on routes that do not.

        Hide attachments attributes Show attachments attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • name string Required
        • providerId string Required
        • convertedName string | null Required
        • convertedProviderId string Required
        • provider string Required
        • size number Required

          Size in bytes

        • transferState number | null Required
      • bcc array[object] Required
      • cc array[object] Required
      • from array[object] Required
      • replyTo array[object] Required
      • to array[object] Required
      • folders array[string] Required
      • grantId string Required
      • externalId string Required
      • object string | null Required
      • snippet string | null Required
      • starred boolean Required
      • unread boolean Required
      • subject string | null Required
      • threadId string Required
      • threadIndex number Required
      • tags array[object] | null Required

        The full record on routes that load it; null (or an empty list) on routes that do not.

        Hide tags attributes Show tags attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • name string Required
        • nameLowercase string Required
        • backgroundColor string Required
        • textColor string Required
        • type string Required

          Values are system, organization, case, or user.

        • severity string Required

          Values are info, warning, or danger.

        • origin string Required

          Values are manual or auto-import.

        • creatorAccessType string | null

          Values are org or opposing_council.

        • isActive boolean Required
      • attachedTags array[object]
        Hide attachedTags attributes Show attachedTags attributes object

        • tagId string Required

          Tag id (Tag._id)

        • tag string Required

          Tag display name (Tag.name)

        • addedBy string Required

          Values are user, ai, auto, auto-import, system, or default.

        • addedById string | null
        • removedAt string(date-time) | null
        • removedBy string | null

          Values are user, ai, auto, auto-import, system, or default.

        • removedById string | null
  • statusCode number Required
  • timestamp string(date-time) Required