Body Required

• addMode string Required

  Values are by_id or by_search.

• tags array[string] Required

  Tag ids or names to ADD (additive union).

  At least 1 but not more than 100 elements.

• ids array[string]

  Not more than 500 elements.

• search object
  Hide search attributes Show search attributes object

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

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

    Filter by participant domain(s) (part after @), any-of. Case-insensitive.

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

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

  • starred boolean
  • unread boolean
  • untagged boolean

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

  • startDate string(date-time)

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

  • endDate string(date-time)

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

  • sourceEmails array[string]
  • sortBy string

    Values are subject, latestMessageSentDate, or latestMessageReceivedDate. Default value is latestMessageReceivedDate.

  • includeLastMessage boolean

    When truthy (1/true), populate lastMessageOrDraft (id/subject); otherwise it is returned as null. The message body is never included — use the thread snippet for previews, or fetch the body from the thread-emails endpoint.

  • includeHidden boolean

    When true, include hidden threads (hiddenAt != null). Default false: hidden threads are excluded from the listing.

    Default value is false.

  • sharedStatus string

    Opposing-council only. Narrows to threads in one sharing state; ignored for OL/OG callers.

    Values are shared, pending, or not_gated.

• autoTagEmails boolean

  When true, additively tag every email of the affected thread(s).

  Default value is false.