Skip to main content
GET
List Record Email Conversations

Authorizations

Authorization
string
header
required

User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0 access token (audience = the app API audience) as Authorization: Bearer <jwt>. The request resolves to the user's identity and is authorized by their Role on the {companyId} in the path — the same role-based permissions the web app enforces. This is the path the MCP connector uses to act on a user's behalf; endpoints that accept it list both BearerAuth and ApiKeyAuth.

Path Parameters

companyId
string<uuid>
required

Company identifier

entityType
enum<string>
required

Field Model V1 entity type (lowercase kebab-case URL slug). One of the six CRUD entity types: event, exposure, quote, submission, person, organization. policy is NOT valid here — Policy has no generic CRUD (its writes go through the policy transaction endpoints), though it does have a read-only /configuration schema.

Available options:
event,
exposure,
quote,
submission,
person,
organization
entityId
string<uuid>
required

Entity identifier

Query Parameters

Conversations with a message whose subject or body contains this text.

personId
string<uuid>

Conversations with a message from or to this person on the record.

mailboxId
string<uuid>

Conversations with a message found in this mailbox.

from
string<date-time>

Conversations active at or after this time, with an offset or Z.

to
string<date-time>

Conversations last active before this time, with an offset or Z.

mentionsRecord
boolean

When true, only conversations that name the record's number. For an exposure, person or organization, which have no number, only conversations that name any record.

cursor
string

The nextCursor from the previous page. Omit it for the first page.

Response

A page of conversations

items
object[]
required
nextCursor
string | null
required

Null on the last page.