Gent API Documentation

Field reference for request and response objects generated from the live OpenAPI schema.

A 34 schemas

ActiveSequence 6 fields

Field	Type	Required	Notes
enrollment_id	string	required
sequence_id	string	required
current_email	integer	required
total_emails	integer	required
next_email_at	string	required
status	string	required

AddDomain 3 fields

Field	Type	Required	Notes
domain	string	required
domain_use	object	optional
dmarc_policy	DmarcPolicyEnum	optional

AddMember 1 field

Field	Type	Required	Notes
inbox_id	string	required

AdminActivityResponse 2 fields

Field	Type	Required	Notes
events	AuditEntry[]	required
count	integer	required

AdminMetricsResponse 3 fields

Field	Type	Required	Notes
metrics	object	required
tenant_id	string	required
hours	integer	required

AdminTenant 15 fields

Field	Type	Required	Notes
tenant_id	string	required
type	string	required
name	string	required
status	string	required
plan	string	required
owner_id	string	required
mfa_required	boolean	required
audit_retention_days	integer	required
billing_status	string	required
grace_period_days	integer	required
grace_period_ends_at	string:date-time	required
suspension_reason	string	required
closing_at	string:date-time	required
created_at	string:date-time	required
updated_at	string:date-time	required

AdminUser 10 fields

Field	Type	Required	Notes
sub	string	required
email	string	required
display_name	string	required
tenant_id	string	required
role	string	required
status	string	required
mfa_enabled	boolean	required
is_system_admin	boolean	required
created_at	string:date-time	required
updated_at	string:date-time	required

Agenda 3 fields

Field	Type	Required	Notes
window	AgendaWindow	required
count	integer	required
items	AgendaItem[]	required

AgendaItem 20 fields

Field	Type	Required	Notes
type	string	required
id	string	required
title	string	required
date	string	required
start	string	optional
end	string	optional
due	string	optional
overdue	boolean	optional
pending	boolean	optional
calendar	string	optional
location	string	optional
contact_id	string	optional
contact_name	string	optional
anniversary_type	string	optional
message_id	string	optional
file_type	string	optional
version	integer	optional
updated_at	string	optional
source	object	optional
metadata	object	optional

AgendaWindow 3 fields

Field	Type	Required	Notes
start	string:date	required
end	string:date	required
days	integer	required

Alert 12 fields

Field	Type	Required	Notes
id	string	required
inbox_id	string	required
events	string[]	required
delivery	object	required
enabled	boolean	required
retries	integer	required
backoff	string	required
created_at	string:date-time	required
updated_at	string:date-time	required
offset	object	required
threshold	integer	required
filter	object	required

AlertBackoffMetadata 2 fields

Field	Type	Required	Notes
strategy	string	required
description	string	required

AlertDeliveryBuilder 4 fields

Field	Type	Required	Notes
type_field	string	required
target_field	string	required
types	AlertDeliveryTypeMetadata[]	required
fields_by_type	object	required

AlertDeliveryTypeMetadata 4 fields

Field	Type	Required	Notes
type	string	required
description	string	required
required_fields	string[]	required
target_type	string	required

AlertReference 8 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
payload	object	required
fields	AlertReferenceField[]	required
delivery_builder	AlertDeliveryBuilder	required
delivery_types	AlertDeliveryTypeMetadata[]	required
backoff_strategies	AlertBackoffMetadata[]	required
offset_units	string[]	required

AlertReferenceAction 4 fields

Field	Type	Required	Notes
method	string	required
path	string	required
required_fields	string[]	optional
optional_fields	string[]	optional

AlertReferenceField 12 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
type	string	required
format	string	optional
widget	string	required
default	object	optional
min	integer	optional
max	integer	optional
placeholder	string	optional
options	AlertReferenceOption[]	optional
source	AlertReferenceFieldSource	optional

AlertReferenceFieldSource 5 fields

Field	Type	Required	Notes
method	string	required
path	string	required
value_field	string	required
label_field	string	optional
group_field	string	optional

AlertReferenceOption 2 fields

Field	Type	Required	Notes
value	string	required
label	string	required

AnniversaryEntry 2 fields

Field	Type	Required	Notes
type	string	required
date	string	required

ApiEndpoint 3 fields

Field	Type	Required	Notes
path	string	required
visibility	string	required
methods	ApiMethod[]	required

ApiMethod 10 fields

Field	Type	Required	Notes
method	string	required
operation_id	string	required
summary	string	required
description	string	required
tags	string[]	required
auth	string[]	required
scopes	string[]	required
parameters	object[]	required	OpenAPI parameter metadata.
request_body	object	required	OpenAPI request body metadata.
responses	object[]	required	OpenAPI response metadata.

ApiReference 4 fields

Field	Type	Required	Notes
version	string	required
source	string	required
endpoints	ApiEndpoint[]	required
counts	object	required

AppendRows 2 fields

Field	Type	Required	Notes
rows	object[]	required
source_message_id	string	optional

AppendRowsResult 2 fields

Field	Type	Required	Notes
appended	integer	required
rows	FileRow[]	required

AppliedByEnum 1 field

Field	Type	Required	Notes
No fields exposed.

ApplyCalendarLabel 1 field

Field	Type	Required	Notes
label_id	string	required

ApplyLabel 1 field

Field	Type	Required	Notes
label_id	string	required

ApplyThreadLabel 4 fields

Field	Type	Required	Notes
label_id	string	optional
label_key	string	optional
source	object	optional
confidence	number:double	optional

ApprovalStats 4 fields

Field	Type	Required	Notes
queued	integer	required
approved	integer	required
rejected	integer	required
expired	integer	required

Attachment 1 field

Field	Type	Required	Notes
blob_id	string	required

AuditBundle 5 fields

Field	Type	Required	Notes
tenant_id	string	required
period	string	required
generated_at	string:date-time	required
event_count	integer	required
events	object[]	required

AuditEntry 7 fields

Field	Type	Required	Notes
id	string	required
actor	string	required
action	string	required
resource_type	string	required
resource_id	string	required
metadata	object	required
occurred_at	string:date-time	required

AuditLogResponse 2 fields

Field	Type	Required	Notes
events	AuditEntry[]	required
cursor	string	required

B 9 schemas

BackoffEnum 1 field

Field	Type	Required	Notes
No fields exposed.

BehaviorEnum 1 field

Field	Type	Required	Notes
No fields exposed.

BillingUsage 12 fields

Field	Type	Required	Notes
inbox_id	string	optional
tenant_id	string	optional
period	string	required
total_cost	number:double	optional
total_storage_gb	number:double	optional
storage_gb	number:double	optional
breakdown	object	optional
provider_breakdown	object	optional
sends	SendUsage	optional
inboxes	InboxUsage[]	optional
tenants	TenantUsageRow[]	optional
updated_at	string	optional

BillingWebhookResult 1 field

Field	Type	Required	Notes
status	string	required

Broadcast 4 fields

Field	Type	Required	Notes
label_id	string	required
subject	string	required
text_body	string	optional
html_body	string	optional

BroadcastQueued 4 fields

Field	Type	Required	Notes
queued	boolean	required
broadcast_id	string	required
label_id	string	required
label_name	string	required

BroadcastStats 12 fields

Field	Type	Required	Notes
sends	integer	required
recipients_total	integer	required
delivered	integer	required
opened	integer	required
clicked	integer	required
bounced	integer	required
spam_complaints	integer	required
open_rate	number:double	required
click_rate	number:double	required
bounce_rate	number:double	required
spam_rate	number:double	required
by_inbox	object[]	optional

BroadcastStatus 13 fields

Field	Type	Required	Notes
broadcast_id	string	required
label_id	string	required
subject	string	required
status	string	required
sent_count	integer	required
suppressed_count	integer	required
delivered_count	integer	required
bounced_count	integer	required
spam_complaint_count	integer	required
open_count	integer	required
click_count	integer	required
created_at	string	required
updated_at	string	required

BucketTypeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

C 46 schemas

CalendarCollection 4 fields

Field	Type	Required	Notes
id	string	required
name	string	required
color	string	optional
isDefault	boolean	optional

CalendarDeleteHeld 2 fields

Field	Type	Required	Notes
queued	boolean	required
approval_id	string	required

CalendarEvent 12 fields

Field	Type	Required	Notes
id	string	required
calendar_id	string	optional
title	string	required
description	string	optional
start	string	required
duration	string	optional
time_zone	string	optional
status	string	optional
location	string	optional
participants	ParticipantEntry[]	optional
recurrence_rules	object[]	optional
labels	string[]	optional

CalendarEventPage 4 fields

Field	Type	Required	Notes
results	CalendarEvent[]	required
total	integer	required
position	integer	required
limit	integer	required

CapModeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

CapResource 9 fields

Field	Type	Required	Notes
resource	string	required
label	string	optional
cap_label	string	optional
usage_label	string	optional
path	string	required
scope	string	required
limit_field	string	required
current_field	string	optional
unit	string	required

ChangePassword 2 fields

Field	Type	Required	Notes
old_password	string	required
new_password	string	required

ChunkRetentionEnum 1 field

Field	Type	Required	Notes
No fields exposed.

CitationModeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

CognitoDeletion 1 field

Field	Type	Required	Notes
cognito_sub	string	required

CognitoEmailChange 2 fields

Field	Type	Required	Notes
cognito_sub	string	required
new_email	string:email	required

CognitoSync 5 fields

Field	Type	Required	Notes
cognito_sub	string	required
email	string:email	required
display_name	string	optional
region	string	optional
llm_consent	boolean	optional

CompletionEnum 1 field

Field	Type	Required	Notes
No fields exposed.

ComplianceExport 8 fields

Field	Type	Required	Notes
cognito_sub	string	optional
user	object	optional
tenant	object	optional
inboxes	object[]	optional
relationships	object[]	optional
timeline	object[]	optional
audit	object[]	optional
_download	object	optional

ComplianceExportDownload 2 fields

Field	Type	Required	Notes
url	string:uri	required
expires_at	string:date-time	required

ConditionTypeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

ConfirmForgotPassword 3 fields

Field	Type	Required	Notes
email	string:email	required
code	string	required
new_password	string	required

ConfirmSignUp 2 fields

Field	Type	Required	Notes
email	string:email	required
code	string	required

ConsentState 5 fields

Field	Type	Required	Notes
cognito_sub	string	required
terms_accepted	boolean	required
llm_consent	boolean	required
llm_consented_at	string	required
marketing_emails	boolean	required

Contact 13 fields

Field	Type	Required	Notes
id	string	required
full_name	string	required
emails	EmailEntry[]	required
phones	PhoneEntry[]	required
online_services	OnlineServiceEntry[]	required
notes	string	required
anniversaries	AnniversaryEntry[]	required
next_step	object	optional
contact_digest	string	optional
on_cooldown	boolean	optional
enriching	boolean	optional
budget_exceeded	boolean	optional
active_sequences	ActiveSequence[]	optional

ContactDeleteHeld 2 fields

Field	Type	Required	Notes
queued	boolean	required
approval_id	string	required

ContactPage 4 fields

Field	Type	Required	Notes
results	Contact[]	required
total	integer	required
position	integer	required
limit	integer	required

ContactShare 11 fields

Field	Type	Required	Notes
share_id	string	required
tenant_id	string	required
from_inbox_id	string	required
to_inbox_id	string	required
contact_id	string	required
contact_address	string	required
type	string	required
status	string	required
parameters	object	required
created_at	string:date-time	required
resolved_at	string:date-time	required

ContactSummary 2 fields

Field	Type	Required	Notes
id	string	required
full_name	string	required

ContextApplyLabel 3 fields

Field	Type	Required	Notes
entity_id	string	required
entity_type	EntityTypeEnum	required
applied_by	object	optional

ConvertDatetimeRequest 3 fields

Field	Type	Required	Notes
utc	string	required
timezone	string	optional
inbox_id	string	optional

CreateAlert 8 fields

Field	Type	Required	Notes
inbox_id	string	required
events	string[]	required
delivery	Delivery	required
offset	object	optional
threshold	integer	optional
filter	object	optional
retries	integer	optional
backoff	object	optional

CreateContact 8 fields

Field	Type	Required	Notes
inbox_id	string	required
full_name	string	required
emails	EmailEntry[]	optional
phones	PhoneEntry[]	optional
online_services	OnlineServiceEntry[]	optional
notes	string	optional
anniversaries	AnniversaryEntry[]	optional
address_book_id	string	optional

CreateDistributionList 2 fields

Field	Type	Required	Notes
address	string:email	required
name	string	required

CreateEnrollment 7 fields

Field	Type	Required	Notes
inbox_id	string	required
recipient	Recipient	required
sequence_id	string	optional
emails	SequenceEmail[]	optional
exit_on_reply	boolean	optional
exit_condition_prompt	string	optional
source	object	optional

CreateEvent 11 fields

Field	Type	Required	Notes
inbox_id	string	optional
calendar_id	string	required
title	string	required
start	string	required
duration	string	required
time_zone	string	optional
description	string	optional
status	string	optional
location	string	optional
participants	ParticipantEntry[]	optional
recurrence_rules	object[]	optional

CreateFile 14 fields

Field	Type	Required	Notes
name	string	optional
file_type	string	optional
scope	object	optional
inbox_id	string	optional
folder_id	string	optional
instructions	string	optional
thread_id	string	optional
source_message_id	string	optional
content	string	optional
content_type	string	optional
viewers	ShareRef[]	optional
collaborators	ShareRef[]	optional
auto_share_from_thread	boolean	optional
thread_share_role	object	optional

CreateFileVersion 3 fields

Field	Type	Required	Notes
content	string	required
content_type	string	optional
source_message_id	string	optional

CreateFolder 4 fields

Field	Type	Required	Notes
name	string	required
scope	object	optional
inbox_id	string	optional
parent_id	string	optional

CreateInbox 1 field

Field	Type	Required	Notes
address	string:email	required

CreateInvite 5 fields

Field	Type	Required	Notes
role	object	optional
email	string:email	optional
max_uses	integer	optional
expires_at	string:date-time	optional
batch_label	string	optional

CreateInviteRoleEnum 1 field

Field	Type	Required	Notes
No fields exposed.

CreateLabel 4 fields

Field	Type	Required	Notes
inbox_id	string	required
name	string	required
color	string	optional
label_scope	object	optional

CreateSequence 5 fields

Field	Type	Required	Notes
name	string	required
emails	SequenceEmail[]	required
exit_on_reply	boolean	optional
exit_condition_prompt	string	optional
sender_inbox_id	string	optional

CreateShare 6 fields

Field	Type	Required	Notes
type	CreateShareTypeEnum	required
to_inbox_id	string	required
contact_id	string	optional
contact_address	string:email	optional
note	string	optional
labels	string[]	optional

CreateShareTypeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

CreateTask 4 fields

Field	Type	Required	Notes
inbox_id	string	optional
summary	string	required
description	string	optional
due_date	string	optional

CreateTemplate 4 fields

Field	Type	Required	Notes
name	string	required
subject	string	required
body	string	required
variables	string[]	optional

CreateThreadNote 2 fields

Field	Type	Required	Notes
body	string	required
mentions	string:email[]	optional

CreateToken 5 fields

Field	Type	Required	Notes
inbox_id	string	required
scopes	ScopesEnum[]	required
requires_approval	RequiresApprovalEnum[]	optional
label	string	required
expires_at	string:date-time	optional

CreateWorkflowRule 7 fields

Field	Type	Required	Notes
name	string	required
trigger	TriggerEnum	required
tenant_id	string	optional
inbox_id	string	optional
conditions	object[]	optional
writes	object[]	optional
priority	integer	optional

D 23 schemas

DatetimeResult 3 fields

Field	Type	Required	Notes
utc	string	required
local	string	required
timezone	string	required

DefaultModeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

DeletionRequest 2 fields

Field	Type	Required	Notes
detail	string	required
expires_at	string:date-time	required

Delivery 2 fields

Field	Type	Required	Notes
type	DeliveryTypeEnum	required
target	string	optional

DeliveryTypeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

DistributionList 7 fields

Field	Type	Required	Notes
list_id	string	required
tenant_id	string	required
address	string	required
name	string	required
created_by	string	required
created_at	string:date-time	required
updated_at	string:date-time	required

DistributionMember 5 fields

Field	Type	Required	Notes
member_id	string	required
list_id	string	required
inbox_id	string	required
inbox_address	string	required
added_at	string:date-time	required

DmarcPolicyEnum 1 field

Field	Type	Required	Notes
No fields exposed.

DmarcPolicyGuidance 6 fields

Field	Type	Required	Notes
scenario	string	required
domain_use	string	optional
label	string	required
recommended_policy	string	required
record_value	string	required
reason	string	required

DmarcReport 15 fields

Field	Type	Required	Notes
report_key	string	required
tenant_id	string	required
domain	string	required
report_id	string	required
org_name	string	required
source	string	required
source_message_id	string	required
begin_at	string	required
end_at	string	required
received_at	string	required
total_messages	integer	required
aligned_messages	integer	required
failed_messages	integer	required
failure_rate	number:double	required
csv_available	boolean	required

DmarcReportList 2 fields

Field	Type	Required	Notes
results	DmarcReport[]	required
count	integer	required

DmarcStats 8 fields

Field	Type	Required	Notes
reports	integer	optional
records	integer	optional
messages	integer	optional
aligned	integer	optional
failed	integer	optional
pass_rate	number:double	optional
by_domain	object[]	optional
by_source	object[]	optional

DnsRecord 4 fields

Field	Type	Required	Notes
type	string	required
name	string	required
value	string	required
description	string	required

Domain 10 fields

Field	Type	Required	Notes
domain_id	string	required
tenant_id	string	required
domain	string	required
status	string	required
dmarc_policy	string	required
dkim_selector	string	required
verified_at	string:date-time	required
created_at	string:date-time	required
updated_at	string:date-time	required
dns_records	object	required

DomainDnsRecordType 6 fields

Field	Type	Required	Notes
key	string	optional
type	string	required
name	string	optional
purpose	string	required
required	boolean	required
removable_after_verification	boolean	optional

DomainDnsRecordTypeList 4 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
dns_record_types	DomainDnsRecordType[]	required
counts	object	required

DomainReference 7 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
payload	object	required
fields	DomainReferenceField[]	required
dns_record_types	DomainDnsRecordType[]	required
dmarc_policy_guidance	DmarcPolicyGuidance[]	required
setup	DomainSetup	required

DomainReferenceAction 4 fields

Field	Type	Required	Notes
method	string	required
path	string	required
required_fields	string[]	optional
optional_fields	string[]	optional

DomainReferenceField 8 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
type	string	required
format	string	optional
widget	string	required
default	string	optional
options	DomainReferenceOption[]	optional

DomainReferenceOption 3 fields

Field	Type	Required	Notes
value	string	required
label	string	required
default_dmarc_policy	string	optional

DomainSetup 5 fields

Field	Type	Required	Notes
records_source	string	required
subdomain_strategy	string	required
dmarc_default	string	required
dmarc_reporting	string	required
reputation_guidance	string[]	required

DomainUseEnum 1 field

Field	Type	Required	Notes
No fields exposed.

DurationResult 3 fields

Field	Type	Required	Notes
iso	string	required
seconds	integer	required
natural	string	required

E 32 schemas

Edge 7 fields

Field	Type	Required	Notes
source	string	required
target	string	required
types	string[]	required
shared_thread_count	integer	required
shared_calendar_count	integer	required
weight	number:double	required
last_seen_at	string	required

EmailAddress 2 fields

Field	Type	Required	Notes
email	string:email	required
name	string	optional

EmailEntry 2 fields

Field	Type	Required	Notes
label	string	required
address	string:email	required

EmailTemplate 9 fields

Field	Type	Required	Notes
template_id	string	required
tenant_id	string	required
name	string	required
subject	string	required
body	string	required
variables	object[]	required
created_by	string	required
created_at	string:date-time	required
updated_at	string:date-time	required

EnabledFeaturesEnum 1 field

Field	Type	Required	Notes
No fields exposed.

EnrichmentFeature 4 fields

Field	Type	Required	Notes
feature	string	required
group	string	required
description	string	required
requires_consent	boolean	required

EnrichmentFeatureList 4 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
features	EnrichmentFeature[]	required
counts	object	required

EnrichmentFieldSource 6 fields

Field	Type	Required	Notes
method	string	optional
path	string	optional
reference_key	string	optional
value_field	string	required
label_field	string	optional
group_field	string	optional

EnrichmentModel 7 fields

Field	Type	Required	Notes
id	string	required
provider	string	required
input_mtok	number:double	required
output_mtok	number:double	required
context_window	integer	required
max_output	integer	required
available	boolean	required

EnrichmentModelList 4 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
models	EnrichmentModel[]	required
counts	object	required

EnrichmentPricingModel 3 fields

Field	Type	Required	Notes
unit	string	required
input_field	string	required
output_field	string	required

EnrichmentReference 7 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
payload	object	required
fields	EnrichmentReferenceField[]	required
pricing_model	EnrichmentPricingModel	required
models	EnrichmentModel[]	required
features	EnrichmentFeature[]	required

EnrichmentReferenceAction 5 fields

Field	Type	Required	Notes
method	string	required
path	string	required
required_query	string[]	optional
required_fields	string[]	optional
optional_fields	string[]	optional

EnrichmentReferenceField 8 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
type	string	required
widget	string	required
min	number:double	optional
step	number:double	optional
source	EnrichmentFieldSource	optional

Enrollment 14 fields

Field	Type	Required	Notes
enrollment_id	string	required
sequence_id	string	required
contact_id	string	required
inbox_id	string	required
tenant_id	string	required
emails	SequenceEmail[]	required
current_email	integer	required
status	string	required
enrolled_at	string:date-time	required
enrolled_by	string	required
source	object	required
exit_on_reply	boolean	required
exit_condition_prompt	string	required
next_email_at	string:date-time	required

EnrollmentActionActionEnum 1 field

Field	Type	Required	Notes
No fields exposed.

Entities 4 fields

Field	Type	Required	Notes
messages	object[]	required
contacts	ContactSummary[]	required
events	EventSummary[]	required
files	object[]	required

EntityTypeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

ErrorResponse 5 fields

Field	Type	Required	Notes
detail	string	required
message	string	required
code	string	required
request_id	string	required
errors	object	optional

Event 7 fields

Field	Type	Required	Notes
event_id	string	required
tenant_id	string	required
inbox_id	string	required
source	string	required
type	string	required
data	object	required
created_at	string:date-time	required

EventMetadata 8 fields

Field	Type	Required	Notes
type	string	required
category	string	required
description	string	required
config	string[]	optional
offset_units	string[]	optional
pattern	boolean	optional
wildcard	boolean	optional
admin	boolean	optional

EventPage 2 fields

Field	Type	Required	Notes
events	Event[]	required
next_cursor	string	required

EventReference 7 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
payload	object	required
fields	EventReferenceField[]	required
builder	EventReferenceBuilder	required
events	EventMetadata[]	required
categories	object	required

EventReferenceBuilder 4 fields

Field	Type	Required	Notes
group_field	string	required
value_field	string	required
admin_field	string	required
config_hints	string[]	required

EventReferenceField 8 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
type	string	required
widget	string	required
min	integer	optional
source	EventReferenceFieldSource	optional
visible_when	object	optional

EventReferenceFieldSource 4 fields

Field	Type	Required	Notes
reference_key	string	required
value_field	string	required
label_field	string	optional
group_field	string	optional

EventReferencePayloadAction 4 fields

Field	Type	Required	Notes
method	string	required
path	string	required
optional_query	string[]	optional
uses_fields	string[]	optional

EventResult 11 fields

Field	Type	Required	Notes
event_id	string	optional
calendar_id	string	optional
title	string	optional
start	string	optional
duration	string	optional
time_zone	string	optional
description	string	optional
status	string	optional
location	string	optional
participants	object[]	optional
recurrence_rules	object[]	optional

EventSuggestionConfirm 1 field

Field	Type	Required	Notes
calendar_id	string	optional

EventSummary 3 fields

Field	Type	Required	Notes
id	string	required
title	string	required
start	string	required

EventTypeList 5 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
events	EventMetadata[]	required
categories	object	required
counts	object	required

ExcludeSpecialEnum 1 field

Field	Type	Required	Notes
No fields exposed.

F 31 schemas

FailureModeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

FeatureTierEnum 1 field

Field	Type	Required	Notes
No fields exposed.

File 19 fields

Field	Type	Required	Notes
file_id	string	required
name	string	required
file_type	string	required
scope	string	required
inbox_id	string	required
tenant_id	string	required
folder_id	string	required
size	integer	required
content_type	string	required
version	integer	required
row_count	integer	required
schema	object	required
instructions	string	required
thread_id	string	required
source_message_id	string	required
viewers	ShareRef[]	required
collaborators	ShareRef[]	required
created_at	string:date-time	required
updated_at	string:date-time	required

FileDownloadLink 2 fields

Field	Type	Required	Notes
url	string:uri	required
expires_at	string:date-time	required

FileDownloadLinkRequest 1 field

Field	Type	Required	Notes
expires_seconds	integer	optional

FileFolder 8 fields

Field	Type	Required	Notes
folder_id	string	required
name	string	required
scope	string	required
inbox_id	string	required
tenant_id	string	required
parent_id	string	required
created_at	string:date-time	required
updated_at	string:date-time	required

FileOwnerDeletionPolicyEnum 1 field

Field	Type	Required	Notes
No fields exposed.

FileReference 9 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
payload	object	required
fields	FileReferenceField[]	required
access_model	object	required
file_types	string[]	required
scopes	string[]	required
roles	FileRoleCapability[]	required
thread_share_roles	string[]	required

FileReferenceAction 4 fields

Field	Type	Required	Notes
method	string	required
path	string	required
required_fields	string[]	required
optional_fields	string[]	required

FileReferenceField 8 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
type	string	required
widget	string	required
default	boolean	optional
options	object[]	optional
source	object	optional

FileRoleCapability 9 fields

Field	Type	Required	Notes
role	string	required
description	string	required
can_read	boolean	required
can_download	boolean	required
can_edit	boolean	required
can_append_rows	boolean	required
can_delete	boolean	required
can_move	boolean	required
can_share	boolean	required

FileRow 6 fields

Field	Type	Required	Notes
row_id	string	required
file_id	string	required
row_number	integer	required
data	object	required
source_message_id	string	required
created_at	string:date-time	required

FileRows 3 fields

Field	Type	Required	Notes
schema	object	required
schema_fields	object	optional
rows	FileRow[]	required

FileStats 4 fields

Field	Type	Required	Notes
total	integer	required
total_size_bytes	integer	required
total_rows	integer	required
by_type	object	required

FileVersion 6 fields

Field	Type	Required	Notes
version_id	string	required
file_id	string	required
version_number	integer	required
size	integer	required
source_message_id	string	required
created_at	string:date-time	required

FilesStorageCap 11 fields

Field	Type	Required	Notes
tenant_id	string	required
resource	string	optional
description	string	optional
enforcement_note	string	optional
limit_gb	number:double	required
mode	string	optional
alert_thresholds	number:double[]	optional
current_gb	number:double	required
current_bytes	integer	required
pct_used	number:double	required
last_measured_at	string	required

Filter 2 fields

Field	Type	Required	Notes
contact_id	string	optional
label_id	string	optional

Folder 5 fields

Field	Type	Required	Notes
id	string	required
name	string	required
role	string	optional
totalEmails	integer	optional
unreadEmails	integer	optional

FoldersEnum 1 field

Field	Type	Required	Notes
No fields exposed.

ForgotPassword 1 field

Field	Type	Required	Notes
email	string:email	required

ForkThread 10 fields

Field	Type	Required	Notes
subject	string	optional
to	EmailAddress[]	required
cc	EmailAddress[]	optional
bcc	EmailAddress[]	optional
reply_to	EmailAddress[]	optional
text_body	string	optional
html_body	string	optional
attachments	Attachment[]	optional
note	string	optional
ticket	ForkThreadTicket	optional

ForkThreadTicket 5 fields

Field	Type	Required	Notes
class_label_id	string	optional
class_label_key	string	optional
priority	TicketPriorityEnum	optional
assignee_inbox_id	string	optional
due_at	string:date-time	optional

ForwardingConditionList 4 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
condition_types	ForwardingConditionType[]	required
counts	object	required

ForwardingConditionType 5 fields

Field	Type	Required	Notes
value	string	required
label	string	required
requires_value	boolean	required
value_widget	string	optional
placeholder	string	optional

ForwardingConfig 5 fields

Field	Type	Required	Notes
inbox_id	string	required
default_address	string	optional
enabled	boolean	optional
created_at	string:date-time	required
updated_at	string:date-time	required

ForwardingConfigRequest 3 fields

Field	Type	Required	Notes
inbox_id	string	optional
default_address	string:email	optional
enabled	boolean	optional

ForwardingReference 6 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
payload	object	required
config_fields	ForwardingReferenceField[]	required
rule_fields	ForwardingReferenceField[]	required
condition_types	ForwardingConditionType[]	required

ForwardingReferenceAction 5 fields

Field	Type	Required	Notes
method	string	required
path	string	required
required_query	string[]	optional
required_fields	string[]	optional
optional_fields	string[]	optional

ForwardingReferenceField 10 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
type	string	required
format	string	optional
widget	string	required
default	boolean	optional
placeholder	string	optional
step	integer	optional
options	ForwardingConditionType[]	optional

ForwardingRule 9 fields

Field	Type	Required	Notes
rule_id	string	required
inbox_id	string	required
destination	string	required
condition_type	string	required
condition_value	string	optional
enabled	boolean	optional
priority	integer	optional
created_at	string:date-time	required
updated_at	string:date-time	required

ForwardingRuleRequest 6 fields

Field	Type	Required	Notes
inbox_id	string	optional
destination	string:email	required
condition_type	ConditionTypeEnum	required
condition_value	string	optional
enabled	boolean	optional
priority	integer	optional

G 7 schemas

GovernanceTierEnum 1 field

Field	Type	Required	Notes
No fields exposed.

Graph 2 fields

Field	Type	Required	Notes
nodes	Relationship[]	required
edges	Edge[]	optional

GroupActivityResponse 2 fields

Field	Type	Required	Notes
events	TimelineEntry[]	required
cursor	string	required

GroupDetail 11 fields

Field	Type	Required	Notes
id	string	required
label	string	required
color	string	required
messages	integer	required
events	integer	required
contacts	integer	required
files	integer	required
summary	object	required
entities	Entities	required
digest	string	optional
digest_generated_at	string	optional

GroupListResponse 2 fields

Field	Type	Required	Notes
groups	GroupSummary[]	required
cursor	string	required

GroupStats 6 fields

Field	Type	Required	Notes
member_count	integer	required
total_sent	integer	required
total_received	integer	required
avg_response_time_hours	number:double	required
last_contact_at	string	required
health_distribution	HealthDistribution	required

GroupSummary 8 fields

Field	Type	Required	Notes
id	string	required
label	string	required
color	string	required
messages	integer	required
events	integer	required
contacts	integer	required
files	integer	required
summary	object	required

H 7 schemas

Handoff 2 fields

Field	Type	Required	Notes
to_inbox_id	string	required
note	string	optional

HandoffResult 1 field

Field	Type	Required	Notes
contact_id	string	required

HealthDistribution 4 fields

Field	Type	Required	Notes
new	integer	required
strong	integer	required
at_risk	integer	required
dormant	integer	required

HeldAction 12 fields

Field	Type	Required	Notes
approval_id	string	required
inbox_id	string	required
action_type	string	required
token_label	string	required
summary	string	required
status	string	required
queued_at	string:date-time	required
expires_at	string:date-time	required
action	string	required
review	string	required
contract_result	string	required
target_preview	string	required

HeldSend 4 fields

Field	Type	Required	Notes
held_id	string	required
inbox_id	string	required
queued_at	string:date-time	required
period_key	string	required

HeldSendReleaseRequest 1 field

Field	Type	Required	Notes
inbox_id	string	optional

HeldSendReleaseResult 1 field

Field	Type	Required	Notes
released	integer	required

I 13 schemas

ImportAuth 2 fields

Field	Type	Required	Notes
mode	ImportAuthModeEnum	required
password	string	required

ImportAuthModeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

ImportOptions 10 fields

Field	Type	Required	Notes
folders	object	optional
folder_names	string[]	optional
include	string[]	optional
exclude	string[]	optional
exclude_special	ExcludeSpecialEnum[]	optional
dry_run	boolean	optional
compress	boolean	optional
include_deleted	boolean	optional
subscribed_only	boolean	optional
imap_connections	integer	optional

ImportSource 5 fields

Field	Type	Required	Notes
host	string	required
port	integer	optional
security	object	optional
username	string:email	required
auth	object	required

Inbox 7 fields

Field	Type	Required	Notes
inbox_id	string	required
tenant_id	string	required
address	string:email	required
email_domain	string	required
status	string	required
created_at	string:date-time	required
updated_at	string:date-time	required

InboxConfig 7 fields

Field	Type	Required	Notes
default_timezone	string	required
webhook	object	required
missed_reply_threshold_days	integer	required
signature	string	required
label_inference_threshold	number:double	required
collaboration_opt_in	boolean	required
ticketing	object	required

InboxCounts 2 fields

Field	Type	Required	Notes
total	integer	required
active	integer	required

InboxHandoff 5 fields

Field	Type	Required	Notes
inbox_id	string	required
paused_tokens	object[]	required
recent_threads	object[]	required
timeline	object[]	required
relationships	object[]	required

InboxQuota 3 fields

Field	Type	Required	Notes
used_bytes	integer	required
limit_bytes	integer	required
used_pct	number:double	required

InboxStats 7 fields

Field	Type	Required	Notes
period	Period	required
broadcasts	BroadcastStats	required
suppression	SuppressionStats	required
workflows	WorkflowStats	required
approvals	ApprovalStats	required
files	FileStats	required
mailbox	MailboxStats	required

InboxUsage 7 fields

Field	Type	Required	Notes
inbox_id	string	required
total_cost	number:double	required
storage_gb	number:double	required
breakdown	object	required
provider_breakdown	object	optional
sends	SendUsage	required
updated_at	string	optional

IndexStatusEnum 1 field

Field	Type	Required	Notes
No fields exposed.

Invite 11 fields

Field	Type	Required	Notes
token	string	required
tenant_id	string	required
role	string	required
email	string:email	required
max_uses	integer	required
use_count	integer	required
expires_at	string:date-time	required
batch_label	string	required
created_by	string	required
created_at	string:date-time	required
status	string	required

K 1 schemas

KindEnum 1 field

Field	Type	Required	Notes
No fields exposed.

L 13 schemas

LLMConfig 5 fields

Field	Type	Required	Notes
inbox_id	string	required
model	string	required
enabled_features	string[]	required
budget_limit	number:double	required
updated_at	string:date-time	required

Label 12 fields

Field	Type	Required	Notes
id	string	required
inbox_id	string	required
name	string	required
color	string	required
label_scope	string	required
label_type	string	required
key	string	required
system_managed	boolean	required
visibility	string	required
exclusive_group	string	required
created_at	string:date-time	required
updated_at	string:date-time	required

LabelApplication 5 fields

Field	Type	Required	Notes
label_id	string	required
entity_id	string	required
entity_type	string	required
applied_by	string	required
applied_at	string	required

LabelReference 7 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
payload	object	required
fields	LabelReferenceField[]	required
label_scopes	LabelScopeMetadata[]	required
label_types	LabelTypeMetadata[]	required
system_label_key_format	SystemLabelKeyFormat	required

LabelReferenceAction 4 fields

Field	Type	Required	Notes
method	string	required
path	string	required
required_fields	string[]	optional
optional_fields	string[]	optional

LabelReferenceField 9 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
type	string	required
format	string	optional
widget	string	required
default	string	optional
mutable	boolean	optional
options	LabelReferenceOption[]	optional

LabelReferenceOption 2 fields

Field	Type	Required	Notes
value	string	required
label	string	required

LabelScopeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

LabelScopeMetadata 4 fields

Field	Type	Required	Notes
scope	string	required
description	string	required
can_apply	boolean	required
can_remove	boolean	required

LabelTypeMetadata 3 fields

Field	Type	Required	Notes
type	string	required
description	string	required
client_create_supported	boolean	required

LevelEnum 1 field

Field	Type	Required	Notes
No fields exposed.

Login 2 fields

Field	Type	Required	Notes
email	string:email	required
password	string	required

LoginResponse 6 fields

Field	Type	Required	Notes
access_token	string	optional
refresh_token	string	optional
expires_in	integer	optional
token_type	string	optional
challenge	string	optional
session	string	optional

M 17 schemas

MFAChallenge 3 fields

Field	Type	Required	Notes
session	string	required
email	string:email	required
code	string	required

MFASetupConfirm 1 field

Field	Type	Required	Notes
code	string	required

MFASetupResponse 2 fields

Field	Type	Required	Notes
secret_code	string	required
otpauth_uri	string	required

MFAStatusResponse 2 fields

Field	Type	Required	Notes
enabled	boolean	required
required	boolean	required

MailboxFolders 6 fields

Field	Type	Required	Notes
total_emails	integer	required
unread_emails	integer	required
total_threads	integer	required
unread_threads	integer	required
by_role	object	required
by_inbox	object[]	optional

MailboxImport 14 fields

Field	Type	Required	Notes
import_id	string	required
tenant_id	string	required
inbox_id	string	required
provider	string	required
source	object	required
options	object	required
status	string	required
progress	object	required
last_error	string	required
created_by	string	required
created_at	string:date-time	required
updated_at	string:date-time	required
started_at	string:date-time	required
completed_at	string:date-time	required

MailboxImportCreate 3 fields

Field	Type	Required	Notes
provider	object	optional
source	ImportSource	required
options	ImportOptions	optional

MailboxImportCreateProviderEnum 1 field

Field	Type	Required	Notes
No fields exposed.

MailboxStats 2 fields

Field	Type	Required	Notes
storage	MailboxStorage	required
folders	MailboxFolders	required

MailboxStorage 5 fields

Field	Type	Required	Notes
usage_period	string	required
total_size_bytes	integer	required
total_size_gb	number:double	required
updated_at	string	required
by_inbox	object[]	optional

MailboxStorageCap 10 fields

Field	Type	Required	Notes
inbox_id	string	required
resource	string	optional
description	string	optional
enforcement_note	string	optional
limit_gb	number:double	required
mode	string	optional
alert_thresholds	number:double[]	optional
current_gb	number:double	required
pct_used	number:double	required
last_measured_at	string	required

MemberSuggestion 3 fields

Field	Type	Required	Notes
address	string:email	required
contact_id	string	required
co_occurrence_count	integer	required

Message 14 fields

Field	Type	Required	Notes
id	string	optional
message_id	string	optional
thread_id	string	optional
threadId	string	optional
subject	string	optional
from_	EmailAddress[]	optional
to	EmailAddress[]	optional
cc	EmailAddress[]	optional
bcc	EmailAddress[]	optional
received_at	string	optional
sent_at	string	optional
preview	string	optional
hasAttachment	boolean	optional
keywords	object	optional

MessagePage 4 fields

Field	Type	Required	Notes
results	Message[]	required
total	integer	required
position	integer	required
limit	integer	required

MessageResponse 1 field

Field	Type	Required	Notes
message	string	required

MessageSendResult 6 fields

Field	Type	Required	Notes
message_id	string	optional
id	string	optional
thread_id	string	optional
threadId	string	optional
queued	boolean	optional
approval_id	string	optional

ModelIdEnum 1 field

Field	Type	Required	Notes
No fields exposed.

N 1 schemas

NullEnum 1 field

Field	Type	Required	Notes
No fields exposed.

O 5 schemas

OcrEngineEnum 1 field

Field	Type	Required	Notes
No fields exposed.

Offset 2 fields

Field	Type	Required	Notes
value	integer	required
unit	UnitEnum	required

OnlineServiceEntry 6 fields

Field	Type	Required	Notes
label	string	required
service	string	optional
user	string	optional
uri	string	optional
contexts	string[]	optional
pref	integer	optional

OutputTypeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

OwnerTypeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

P 41 schemas

PaddleWebhook 4 fields

Field	Type	Required	Notes
notification_id	string	optional
event_type	string	optional
occurred_at	string	optional
data	object	optional

ParseDatetimeRequest 3 fields

Field	Type	Required	Notes
input	string	required
timezone	string	optional
inbox_id	string	optional

ParseDurationRequest 1 field

Field	Type	Required	Notes
input	string	required

ParticipantEntry 3 fields

Field	Type	Required	Notes
name	string	optional
email	string:email	required
role	string	optional

ParticipantModeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

PatchedAdminUpdateTenant 1 field

Field	Type	Required	Notes
grace_period_days	integer	optional

PatchedContractReviewUpdate 1 field

Field	Type	Required	Notes
values	object	optional

PatchedEnrollmentAction 1 field

Field	Type	Required	Notes
action	EnrollmentActionActionEnum	optional

PatchedForwardingRulePatch 5 fields

Field	Type	Required	Notes
destination	string:email	optional
condition_type	ConditionTypeEnum	optional
condition_value	string	optional
enabled	boolean	optional
priority	integer	optional

PatchedPatchScheduledTask 4 fields

Field	Type	Required	Notes
enabled	boolean	optional
interval_hours	number:double	optional
payload	object	optional
description	string	optional

PatchedRetrievalConfigUpdate 9 fields

Field	Type	Required	Notes
embedding	RetrievalEmbeddingConfig	optional
chunking	RetrievalChunkingConfig	optional
extraction	RetrievalExtractionConfig	optional
refresh	RetrievalRefreshConfig	optional
retention	RetrievalRetentionConfig	optional
public_web	RetrievalPublicWebConfig	optional
retrieval	RetrievalQueryConfig	optional
cost_controls	RetrievalCostControls	optional
sensitive_sources	RetrievalSensitiveSourcesConfig	optional

PatchedRetrievalSystemModelsUpdate 1 field

Field	Type	Required	Notes
models	object[]	optional

PatchedRetrievalSystemSourceTypesUpdate 1 field

Field	Type	Required	Notes
source_types	object[]	optional

PatchedSourceBucketUpdate 5 fields

Field	Type	Required	Notes
name	string	optional
bucket_type	BucketTypeEnum	optional
sources	RetrievalSource[]	optional
policy	object	optional
index_status	IndexStatusEnum	optional

PatchedTenantLimitsUpdate 11 fields

Field	Type	Required	Notes
max_inboxes_override	integer	optional
max_domains_override	integer	optional
max_desk_seats_override	integer	optional
addon_inboxes	integer	optional
addon_domains	integer	optional
addon_desk_seats	integer	optional
addon_workflows	integer	optional
max_workflows_override	integer	optional
workflows_override	object	optional
intelligence_override	object	optional
governance_override	object	optional

PatchedTenantUpdate 6 fields

Field	Type	Required	Notes
plan	PlanEnum	optional
status	TenantUpdateStatusEnum	optional
mfa_required	boolean	optional
audit_retention_days	integer	optional
grace_period_days	integer	optional
suspension_reason	string	optional

PatchedThreadTicket 6 fields

Field	Type	Required	Notes
class_label_id	string	optional
class_label_key	string	optional
priority	TicketPriorityEnum	optional
status	ThreadTicketStatusEnum	optional
assignee_inbox_id	string	optional
due_at	string:date-time	optional

PatchedTokenAction 1 field

Field	Type	Required	Notes
action	TokenActionActionEnum	optional

PatchedUpdateAlert 8 fields

Field	Type	Required	Notes
events	string[]	optional
delivery	Delivery	optional
offset	object	optional
threshold	integer	optional
filter	object	optional
retries	integer	optional
backoff	BackoffEnum	optional
enabled	boolean	optional

PatchedUpdateContact 6 fields

Field	Type	Required	Notes
full_name	string	optional
emails	EmailEntry[]	optional
phones	PhoneEntry[]	optional
online_services	OnlineServiceEntry[]	optional
notes	string	optional
anniversaries	AnniversaryEntry[]	optional

PatchedUpdateDistributionList 1 field

Field	Type	Required	Notes
name	string	optional

PatchedUpdateEvent 9 fields

Field	Type	Required	Notes
title	string	optional
start	string	optional
duration	string	optional
time_zone	string	optional
description	string	optional
status	string	optional
location	string	optional
participants	ParticipantEntry[]	optional
recurrence_rules	object[]	optional

PatchedUpdateFile 8 fields

Field	Type	Required	Notes
name	string	optional
folder_id	string	optional
instructions	string	optional
viewers	ShareRef[]	optional
collaborators	ShareRef[]	optional
auto_share_from_thread	boolean	optional
thread_id	string	optional
thread_share_role	object	optional

PatchedUpdateFolder 2 fields

Field	Type	Required	Notes
name	string	optional
parent_id	string	optional

PatchedUpdateInboxConfig 7 fields

Field	Type	Required	Notes
default_timezone	string	optional
webhook	object	optional
missed_reply_threshold_days	integer	optional
signature	string	optional
label_inference_threshold	number:double	optional
collaboration_opt_in	boolean	optional
ticketing	TicketingConfig	optional

PatchedUpdateLabel 3 fields

Field	Type	Required	Notes
name	string	optional
color	string	optional
label_scope	LabelScopeEnum	optional

PatchedUpdateMessage 3 fields

Field	Type	Required	Notes
mark_read	boolean	optional
mark_starred	boolean	optional
mailbox_id	string	optional

PatchedUpdateProfile 1 field

Field	Type	Required	Notes
display_name	string	optional

PatchedUpdateSequence 5 fields

Field	Type	Required	Notes
name	string	optional
emails	SequenceEmail[]	optional
exit_on_reply	boolean	optional
exit_condition_prompt	string	optional
sender_inbox_id	string	optional

PatchedUpdateTask 3 fields

Field	Type	Required	Notes
completed	boolean	optional
summary	string	optional
due_date	string	optional

PatchedUpdateTemplate 4 fields

Field	Type	Required	Notes
name	string	optional
subject	string	optional
body	string	optional
variables	string[]	optional

PatchedUpdateTenant 8 fields

Field	Type	Required	Notes
name	string	optional
mfa_required	boolean	optional
audit_retention_days	integer	optional
collaboration_enabled	boolean	optional
file_owner_deletion_policy	FileOwnerDeletionPolicyEnum	optional
send_cap_mode	CapModeEnum	optional
storage_cap_mode	CapModeEnum	optional
workflow_review_defaults	object	optional

PatchedUpdateWorkflowRule 4 fields

Field	Type	Required	Notes
conditions	object[]	optional
writes	object[]	optional
priority	integer	optional
enabled	boolean	optional

PatchedUserUpdate 3 fields

Field	Type	Required	Notes
status	UserUpdateStatusEnum	optional
role	UserUpdateRoleEnum	optional
is_system_admin	boolean	optional

PatchedWorkRouteUpdate 4 fields

Field	Type	Required	Notes
title	string	optional
description	string	optional
due_at	string:date-time	optional
failure_mode	FailureModeEnum	optional

PatchedWorkflowWriteTemplatePatch 9 fields

Field	Type	Required	Notes
name	string	optional
tenant_id	string	optional
inbox_id	string	optional
description	string	optional
source	object	optional
target	object	optional
contract	object	optional
policy	object	optional
review_policy	object	optional

PendingThreadSummary 2 fields

Field	Type	Required	Notes
status	string	required
thread_id	string	required

Period 2 fields

Field	Type	Required	Notes
since	string	required
until	string	required

PeriodEnum 1 field

Field	Type	Required	Notes
No fields exposed.

PhoneEntry 2 fields

Field	Type	Required	Notes
label	string	required
number	string	required

PlanEnum 1 field

Field	Type	Required	Notes
No fields exposed.

R 44 schemas

Recipient 2 fields

Field	Type	Required	Notes
contact_id	string	optional
email	string:email	optional

ReferenceAction 5 fields

Field	Type	Required	Notes
method	string	required
path	string	optional
paths	string[]	optional
required_fields	string[]	optional
optional_fields	string[]	optional

ReferenceEndpoint 6 fields

Field	Type	Required	Notes
path	string	required
description	string	required
auth	string	required
resource	string	optional
contract	boolean	optional
kind	string	optional

ReferenceField 12 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
type	string	required
widget	string	required
min	integer	optional
max	integer	optional
min_length	integer	optional
max_length	integer	optional
requires_feature	string	optional
requires_plan	string	optional
options	ReferenceOption[]	optional

ReferenceIndex 3 fields

Field	Type	Required	Notes
references	ReferenceEndpoint[]	required
profiles	object	optional
counts	object	required

ReferenceOption 2 fields

Field	Type	Required	Notes
value	string	required
label	string	required

Refresh 1 field

Field	Type	Required	Notes
refresh_token	string	optional

RefreshEnum 1 field

Field	Type	Required	Notes
No fields exposed.

RefreshResponse 3 fields

Field	Type	Required	Notes
access_token	string	required
expires_in	integer	required
token_type	string	required

RegionEnum 1 field

Field	Type	Required	Notes
No fields exposed.

Relationship 14 fields

Field	Type	Required	Notes
id	string	required
email	string	required
contact_id	string	required
inbox_id	string	required
email_sent_count	integer	required
email_received_count	integer	required
email_first_at	string:date-time	required
email_last_at	string:date-time	required
last_sent_at	string:date-time	required
last_received_at	string:date-time	required
last_contact_at	string:date-time	required
is_gent_user	boolean	required
intelligence	object	required
collaboration	object	required	Overlap and expertise data. Only populated when: - the serializer context includes ``tenant_id`` - the tenant has collaboration_enabled - the requesting inbox has opted in

RenderTemplate 1 field

Field	Type	Required	Notes
context	object	optional

RenderTemplateResult 2 fields

Field	Type	Required	Notes
subject	string	required
body	string	required

RequestTypeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

RequiresApprovalEnum 1 field

Field	Type	Required	Notes
No fields exposed.

ResendConfirmation 1 field

Field	Type	Required	Notes
email	string:email	required

ResultsList 1 field

Field	Type	Required	Notes
results	object[]	required

RetrievalChunkingConfig 3 fields

Field	Type	Required	Notes
strategy	StrategyEnum	optional
max_chars	integer	optional
overlap_chars	integer	optional

RetrievalConfig 6 fields

Field	Type	Required	Notes
tenant_id	string	required
config	object	required
models	object[]	optional
source_types	object[]	optional
updated_by	string	required
updated_at	string:date-time	required

RetrievalCostControls 3 fields

Field	Type	Required	Notes
require_estimate_before_indexing	boolean	optional
monthly_index_token_limit	integer	optional
monthly_run_limit	integer	optional

RetrievalEmbeddingConfig 3 fields

Field	Type	Required	Notes
provider	RetrievalEmbeddingConfigProviderEnum	optional
model_id	ModelIdEnum	optional
dimension	integer	optional

RetrievalEmbeddingConfigProviderEnum 1 field

Field	Type	Required	Notes
No fields exposed.

RetrievalExtractionConfig 4 fields

Field	Type	Required	Notes
file_types	string[]	optional
ocr_engine	OcrEngineEnum	optional
max_files	integer	optional
max_rows_per_spreadsheet	integer	optional

RetrievalExtractionTestRequest 5 fields

Field	Type	Required	Notes
file_id	string	required
chunking	RetrievalChunkingConfig	optional
extraction	RetrievalExtractionConfig	optional
include_sample	boolean	optional
sample_chars	integer	optional

RetrievalExtractionTestResponse 18 fields

Field	Type	Required	Notes
file_id	string	required
file_name	string	required
file_type	string	required
content_type	string	required
extraction_type	string	required
extractor	string	required
status	string	required
chunk_count	integer	required
total_chars	integer	required
sample	string	required
ocr_engine	string	required
ocr_required	boolean	required
truncated	boolean	optional
row_count	integer	optional
rows_extracted	integer	optional
page_count	integer	optional
source_warnings	string[]	optional
warnings	string[]	required

RetrievalIndexChunk 6 fields

Field	Type	Required	Notes
source_type	string	optional
source_id	string	optional
text	string	required
text_ref	string	optional
visibility	VisibilityEnum	optional
metadata	object	optional

RetrievalIndexEstimateRequest 3 fields

Field	Type	Required	Notes
force	boolean	optional
chunks	RetrievalIndexChunk[]	optional
sensitive_source_approved	boolean	optional

RetrievalIndexEstimateResponse 18 fields

Field	Type	Required	Notes
bucket_id	string	required
estimate_id	string	required
source_count	integer	required
explicit_chunk_count	integer	required
explicit_char_count	integer	optional
estimated_chunks	integer	required
estimated_input_tokens	integer	required
estimated_embedding_requests	integer	required
source_estimates	object[]	optional
extraction_metadata	object	optional
skipped_sources	object[]	optional
extraction_warnings	string[]	optional
billable_warnings	string[]	optional
model	object	required
cost_policy	object	required
requires_confirmation	boolean	required
warnings	string[]	required
notes	string[]	required

RetrievalIndexRequest 3 fields

Field	Type	Required	Notes
force	boolean	optional
chunks	RetrievalIndexChunk[]	optional
sensitive_source_approved	boolean	optional

RetrievalIndexResponse 5 fields

Field	Type	Required	Notes
bucket_id	string	required
index_status	string	required
queued	boolean	required
task	string	required
trigger	string	required

RetrievalModelList 5 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
models	object[]	required
pricing_policy	object	required
counts	object	required

RetrievalPublicWebConfig 3 fields

Field	Type	Required	Notes
default_mode	DefaultModeEnum	optional
max_pages	integer	optional
respect_robots	boolean	optional

RetrievalQueryConfig 3 fields

Field	Type	Required	Notes
top_k	integer	optional
min_score	number:double	optional
citation_mode	CitationModeEnum	optional

RetrievalReference 14 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
plan_gate	object	required
payload	object	required
fields	object[]	required
source_types	object[]	required
bucket_types	object[]	required
tasks	object[]	required
output_types	object[]	required
vector_storage	object	required
refresh_policy	object	required
usage_tracking	object	required
run_result_codes	object[]	required
scopes	object	required

RetrievalRefreshConfig 1 field

Field	Type	Required	Notes
default_mode	DefaultModeEnum	optional

RetrievalRetentionConfig 1 field

Field	Type	Required	Notes
chunk_retention	ChunkRetentionEnum	optional

RetrievalRunCreate 6 fields

Field	Type	Required	Notes
inbox_id	string	optional
bucket_id	string	required
task	TaskEnum	required
query	string	required
context	object	optional
output_type	object	optional

RetrievalRunRead 15 fields

Field	Type	Required	Notes
run_id	string	required
tenant_id	string	required
inbox_id	string	required
bucket_id	string	required
task	string	required
query	string	required
status	string	required
output_type	string	required
context	object	required
answer	object	required
citations	object[]	required
usage	object	required
actor	string	required
created_at	string:date-time	required
completed_at	string:date-time	required

RetrievalSensitiveSourcesConfig 1 field

Field	Type	Required	Notes
require_approval	boolean	optional

RetrievalSource 15 fields

Field	Type	Required	Notes
type	RetrievalSourceTypeEnum	required
scope	RetrievalSourceScopeEnum	optional
thread_id	string	optional
contact_id	string	optional
label_id	string	optional
inbox_id	string	optional
folder_id	string	optional
calendar_id	string	optional
event_id	string	optional
include_children	boolean	optional
include_history	boolean	optional
allowed_domains	string[]	optional
seed_urls	string:uri[]	optional
max_pages	integer	optional
refresh	object	optional

RetrievalSourceScopeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

RetrievalSourceTypeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

RetrievalSystemAllowlist 7 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
models	object[]	optional
source_types	object[]	optional
pricing_policy	object	optional
updated_by	string	optional
updated_at	string:date-time	optional

RoutingModeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

S 37 schemas

ScheduledTask 7 fields

Field	Type	Required	Notes
task_name	string	required
enabled	boolean	required
interval_hours	number:double	required
payload	object	required
description	string	required
last_run_at	string:date-time	required
updated_at	string:date-time	required

Scope4a3Enum 1 field

Field	Type	Required	Notes
No fields exposed.

ScopesEnum 1 field

Field	Type	Required	Notes
No fields exposed.

SecurityEnum 1 field

Field	Type	Required	Notes
No fields exposed.

SendCap 7 fields

Field	Type	Required	Notes
inbox_id	string	required
period	string	optional
limit	integer	optional
behavior	string	optional
mode	string	optional
current_count	integer	required
resets_at	string	required

SendCapRequest 5 fields

Field	Type	Required	Notes
inbox_id	string	optional
period	object	optional
limit	integer	optional
behavior	object	optional
mode	object	optional

SendMessage 9 fields

Field	Type	Required	Notes
reply_to_message_id	string	optional
subject	string	optional
to	EmailAddress[]	optional
cc	EmailAddress[]	optional
bcc	EmailAddress[]	optional
reply_to	EmailAddress[]	optional
text_body	string	optional
html_body	string	optional
attachments	Attachment[]	optional

SendUsage 4 fields

Field	Type	Required	Notes
total	integer	required
included	integer	required
overage	integer	required
overage_cost	number:double	required

SenderRuleConfig 7 fields

Field	Type	Required	Notes
inbox_id	string	required
inbound_mode	string	optional
outbound_mode	string	optional
inbound_patterns	string[]	optional
outbound_patterns	string[]	optional
created_at	string:date-time	required
updated_at	string:date-time	required

SenderRuleConfigRequest 5 fields

Field	Type	Required	Notes
inbox_id	string	optional
inbound_mode	object	optional
outbound_mode	object	optional
inbound_patterns	string[]	optional
outbound_patterns	string[]	optional

SenderRuleMode 3 fields

Field	Type	Required	Notes
value	string	required
label	string	required
behavior	string	required

SenderRuleModeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

SenderRuleModeList 4 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
modes	SenderRuleMode[]	required
counts	object	required

SenderRulePatternHelp 3 fields

Field	Type	Required	Notes
supports	string[]	required
examples	string[]	required
note	string	required

SenderRuleReference 7 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
payload	object	required
fields	SenderRuleReferenceField[]	required
modes	SenderRuleMode[]	required
helper_text	string	required
pattern_help	SenderRulePatternHelp	required

SenderRuleReferenceAction 5 fields

Field	Type	Required	Notes
method	string	required
path	string	required
required_query	string[]	optional
required_fields	string[]	optional
optional_fields	string[]	optional

SenderRuleReferenceField 7 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
type	string	required
widget	string	required
placeholder	string	optional
options	SenderRuleMode[]	optional

Sequence 10 fields

Field	Type	Required	Notes
sequence_id	string	required
tenant_id	string	required
name	string	required
emails	SequenceEmail[]	required
exit_on_reply	boolean	required
exit_condition_prompt	string	required
sender_inbox_id	string	required
created_by	string	required
created_at	string:date-time	required
updated_at	string:date-time	required

SequenceEmail 4 fields

Field	Type	Required	Notes
delay_days	integer	optional
prompt	string	optional
body	string	optional
subject	string	optional

SequenceReference 12 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
payload	object	required
sequence_fields	SequenceReferenceField[]	required
email_fields	SequenceReferenceField[]	required
recipient_fields	SequenceReferenceField[]	required
source_fields	SequenceReferenceField[]	required
enrollment_fields	SequenceReferenceField[]	required
validation	SequenceValidation	required
defaults	object	required
statuses	object[]	required
actions	object[]	required

SequenceReferenceField 14 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
type	string	required
format	string	optional
widget	string	required
max_length	integer	optional
rows	integer	optional
default	object	optional
min	integer	optional
step	integer	optional
fields	string[]	optional
options	object[]	optional
source	object	optional

SequenceReferencePayloadAction 6 fields

Field	Type	Required	Notes
method	string	required
path	string	required
required_fields	string[]	optional
optional_fields	string[]	optional
conditional_fields	object[]	optional
fixed_fields	object	optional

SequenceValidation 4 fields

Field	Type	Required	Notes
name_max_length	integer	required
min_emails	integer	required
email_requires_any_of	string[]	required
delay_days_min	integer	required

SetWebhook 3 fields

Field	Type	Required	Notes
url	string:uri	required
events	string[]	optional
secret	string	optional

ShareRef 4 fields

Field	Type	Required	Notes
type	string	optional
id	string	optional
email	string:email	optional
role	string	optional

SignUp 7 fields

Field	Type	Required	Notes
email	string:email	required
password	string	required
display_name	string	optional
invite_token	string	optional
signup_token	string	optional
region	object	optional
llm_consent	boolean	optional

Source 10 fields

Field	Type	Required	Notes
type	SourceTypeEnum	optional
channel	string	optional
channel_account_id	string	optional
conversation_id	string	optional
message_id	string	optional
thread_id	string	optional
participant_mode	ParticipantModeEnum	optional
subject	string	optional
from_address	string:email	optional
channel_event	object	optional

SourceBucketCreate 6 fields

Field	Type	Required	Notes
name	string	required
bucket_type	BucketTypeEnum	required
owner_type	OwnerTypeEnum	required
owner_id	string	required
sources	RetrievalSource[]	required
policy	object	optional

SourceBucketRead 21 fields

Field	Type	Required	Notes
bucket_id	string	required
tenant_id	string	required
owner_type	string	required
owner_id	string	required
name	string	required
bucket_type	string	required
sources	object[]	required
policy	object	required
last_index_summary	object	optional
last_index_error	string	optional
last_index_error_code	string	optional
refresh	object	optional
vector_backend	string	required
vector_index_name	string	required
embedding_model	string	required
vector_dimension	string	required
index_status	string	required
last_indexed_at	string:date-time	required
created_by	string	required
created_at	string:date-time	required
updated_at	string:date-time	required

SourceEnum 1 field

Field	Type	Required	Notes
No fields exposed.

SourceTypeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

StorageCapRequest 4 fields

Field	Type	Required	Notes
inbox_id	string	optional
limit_gb	number:double	required
mode	object	optional
alert_thresholds	number:double[]	optional

StrategyEnum 1 field

Field	Type	Required	Notes
No fields exposed.

Suppression 3 fields

Field	Type	Required	Notes
address	string:email	required
reason	string	optional
suppressed_at	string	optional

SuppressionStats 5 fields

Field	Type	Required	Notes
total	integer	required
hard_bounce	integer	optional
spam_complaint	integer	optional
unsubscribed	integer	optional
by_inbox	object[]	optional

SystemLabelKeyFormat 2 fields

Field	Type	Required	Notes
format	string	required
examples	string[]	required

SystemStats 13 fields

Field	Type	Required	Notes
period	Period	optional
tenants	TenantSummary	optional
dmarc	DmarcStats	optional
note	string	optional
tenant	TenantMetadata	optional
error	string	optional
inboxes	InboxCounts	optional
broadcasts	BroadcastStats	optional
suppression	SuppressionStats	optional
workflows	WorkflowStats	optional
approvals	ApprovalStats	optional
files	FileStats	optional
mailbox	MailboxStats	optional

T 52 schemas

Task 8 fields

Field	Type	Required	Notes
id	string	required
summary	string	required
description	string	optional
due_date	string	optional
completed	boolean	optional
completed_at	string	optional
created_at	string	optional
updated_at	string	optional

TaskEnum 1 field

Field	Type	Required	Notes
No fields exposed.

TaskList 2 fields

Field	Type	Required	Notes
results	Task[]	required
count	integer	required

Tenant 21 fields

Field	Type	Required	Notes
tenant_id	string	required
type	string	required
status	string	required
name	string	required
region	string	required
plan	string	required
mfa_required	boolean	required
audit_retention_days	integer	required
file_owner_deletion_policy	string	required
send_cap_mode	string	required
storage_cap_mode	string	required
workflow_review_defaults	string	required
collaboration_enabled	boolean	required
llm_consent	boolean	required
llm_consented_at	string:date-time	required
llm_consented_by	string	required
billing_status	string	required
grace_period_days	integer	required
grace_period_ends_at	string:date-time	required
suspension_reason	string	required
created_at	string:date-time	required

TenantCapBuilder 3 fields

Field	Type	Required	Notes
modes	ReferenceOption[]	required
send_behaviors	ReferenceOption[]	required
resources	CapResource[]	required

TenantCapModeList 4 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
modes	ReferenceOption[]	required
counts	object	required

TenantCapResourceList 4 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
resources	CapResource[]	required
counts	object	required

TenantLimits 22 fields

Field	Type	Required	Notes
tenant_id	string	required
plan	string	required
max_inboxes_override	integer	required
max_domains_override	integer	required
max_desk_seats_override	integer	required
max_workflows_override	integer	required
addon_inboxes	integer	required
addon_domains	integer	required
addon_desk_seats	integer	required
addon_workflows	integer	required
workflows_override	string	required
intelligence_override	string	required
governance_override	string	required
effective_inboxes	integer	required
effective_domains	integer	required
effective_desk_seats	integer	required
effective_workflows	integer	required
effective_workflows_tier	string	required
effective_intelligence	string	required
effective_governance	string	required
updated_at	string	required
updated_by	string	required

TenantListResponse 2 fields

Field	Type	Required	Notes
tenants	AdminTenant[]	required
count	integer	required

TenantMetadata 5 fields

Field	Type	Required	Notes
tenant_id	string	required
name	string	required
plan	string	required
status	string	required
type	string	required

TenantReference 13 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
payload	object	required
fields	ReferenceField[]	required
workflow_review_policy	object	optional
cap_builder	TenantCapBuilder	required
file_owner_deletion_policies	string[]	required
cap_modes	string[]	required
plans	string[]	optional
tenant_statuses	string[]	optional
user_roles	string[]	optional
user_statuses	string[]	optional
feature_tiers	object	optional

TenantStats 9 fields

Field	Type	Required	Notes
period	Period	required
broadcasts	BroadcastStats	required
suppression	SuppressionStats	required
workflows	WorkflowStats	required
approvals	ApprovalStats	required
files	FileStats	required
mailbox	MailboxStats	required
inboxes	InboxCounts	required
dmarc	DmarcStats	required

TenantSummary 3 fields

Field	Type	Required	Notes
total	integer	required
by_plan	object	required
by_status	object	required

TenantUpdateStatusEnum 1 field

Field	Type	Required	Notes
No fields exposed.

TenantUsageRow 3 fields

Field	Type	Required	Notes
tenant_id	string	required
total_cost	number:double	required
total_storage_gb	number:double	required

Thread 2 fields

Field	Type	Required	Notes
id	string	required
emailIds	string[]	optional

ThreadAssign 2 fields

Field	Type	Required	Notes
to	string:email	required
note	string	optional

ThreadAssignResult 2 fields

Field	Type	Required	Notes
assigned	boolean	required
to	string:email	required

ThreadForkResult 4 fields

Field	Type	Required	Notes
thread_id	string	optional
message_id	string	optional
ticket	object	optional
note	object	optional

ThreadLabelResult 9 fields

Field	Type	Required	Notes
application_id	string	optional
thread_id	string	optional
label_id	string	optional
label_key	string	optional
exclusive_group	string	optional
source	string	optional
confidence	number:double	optional
applied_by	string	optional
created_at	string	optional

ThreadList 3 fields

Field	Type	Required	Notes
results	object[]	required
total	integer	required
limit	integer	required

ThreadNote 6 fields

Field	Type	Required	Notes
note_id	string	required
author_inbox_id	string	optional
author	string	optional
body	string	required
mentions	string[]	optional
created_at	string	optional

ThreadShareRoleEnum 1 field

Field	Type	Required	Notes
No fields exposed.

ThreadSummary 8 fields

Field	Type	Required	Notes
thread_id	string	required
summary	string	optional
decisions	object[]	optional
action_items	object[]	optional
status	string	required
stale	boolean	optional
message_count	integer	optional
updated_at	string	optional

ThreadTicket 6 fields

Field	Type	Required	Notes
class_label_id	string	optional
class_label_key	string	optional
priority	TicketPriorityEnum	optional
status	ThreadTicketStatusEnum	optional
assignee_inbox_id	string	optional
due_at	string:date-time	optional

ThreadTicketStatusEnum 1 field

Field	Type	Required	Notes
No fields exposed.

Ticket 13 fields

Field	Type	Required	Notes
ticket_id	string	optional
thread_id	string	optional
source_context	object	optional
inbox_id	string	optional
tenant_id	string	optional
status	string	optional
priority	string	optional
class_label_id	string	optional
class_label_key	string	optional
assignee_inbox_id	string	optional
due_at	string	optional
created_at	string	optional
updated_at	string	optional

TicketClassConfig 5 fields

Field	Type	Required	Notes
required_fields	string[]	required
optional_fields	string[]	required
fields	TicketClassField[]	required
retrieval	object	optional
matching	TicketClassMatching	required

TicketClassField 17 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
widget	string	required
prefix	string	optional
placeholder	string	optional
pattern	string	optional
max_length	integer	optional
options_ref	string	optional
default	string	optional
empty_label	string	optional
min	integer	optional
step	integer	optional
max_items	integer	optional
item_max_length	integer	optional
item_type	string	optional
description	string	required

TicketClassMatching 3 fields

Field	Type	Required	Notes
deterministic	boolean	required
order	string[]	required
description	string	required

TicketEndpoint 4 fields

Field	Type	Required	Notes
method	string	required
path	string	required
required_fields	string[]	required
optional_fields	string[]	required

TicketLabelGroup 6 fields

Field	Type	Required	Notes
group	string	required
prefix	string	required
exclusive	boolean	required
visibility	string	required
manual_apply	boolean	required
description	string	required

TicketPriorityEnum 1 field

Field	Type	Required	Notes
No fields exposed.

TicketReference 8 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
system_label_key_format	string	required
label_groups	TicketLabelGroup[]	required
statuses	string[]	required
priorities	string[]	required
class_config	TicketClassConfig	required
endpoints	object	required

TicketReopen 1 field

Field	Type	Required	Notes
reason	string	optional

TicketResolution 1 field

Field	Type	Required	Notes
resolution_note	string	required

TicketingClassConfig 9 fields

Field	Type	Required	Notes
label_key	string	required
default_assignee_inbox_id	string	optional
default_priority	object	optional
due_hours	integer	optional
keywords	string[]	optional
sender_domains	string[]	optional
sender_addresses	string:email[]	optional
recipient_addresses	string:email[]	optional
retrieval	object	optional

TicketingConfig 3 fields

Field	Type	Required	Notes
enabled	boolean	optional
auto_create_from_inbound	boolean	optional
classes	TicketingClassConfig[]	optional

TimelineEntry 10 fields

Field	Type	Required	Notes
id	string	required
inbox_id	string	required
contact_address	string	required
contact_id	string	optional
type	string	required
resource_id	string	required
participants	string[]	optional
summary	string	required
occurred_at	string:date-time	required
metadata	object	required

TimelineResponse 2 fields

Field	Type	Required	Notes
events	TimelineEntry[]	required
cursor	string	required

Token 12 fields

Field	Type	Required	Notes
token_id	string	required
inbox_id	string	required
scopes	string[]	required	Parse the stored scope field into a list (handles legacy single-scope strings).
requires_approval	string[]	required	Parse the stored requires_approval field into a list.
label	string	required
token_prefix	string	required
status	string	required
paused	boolean	required
paused_at	string:date-time	required
expires_at	string:date-time	required
created_at	string:date-time	required
updated_at	string:date-time	required

TokenActionActionEnum 1 field

Field	Type	Required	Notes
No fields exposed.

TokenCreated 13 fields

Field	Type	Required	Notes
token_id	string	required
inbox_id	string	required
scopes	string[]	required	Parse the stored scope field into a list (handles legacy single-scope strings).
requires_approval	string[]	required	Parse the stored requires_approval field into a list.
label	string	required
token_prefix	string	required
status	string	required
paused	boolean	required
paused_at	string:date-time	required
expires_at	string:date-time	required
created_at	string:date-time	required
updated_at	string:date-time	required
raw_token	string	required

TokenReference 7 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
payload	object	required
fields	TokenReferenceField[]	required
scope_builder	TokenScopeBuilder	required
scopes	TokenScopeMetadata[]	required
composites	object	required

TokenReferenceAction 6 fields

Field	Type	Required	Notes
method	string	required
path	string	required
required_fields	string[]	optional
optional_fields	string[]	optional
required_query	string[]	optional
optional_query	string[]	optional

TokenReferenceField 9 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
type	string	required
format	string	optional
widget	string	required
source	TokenReferenceFieldSource	optional
options	TokenReferenceOption[]	optional
admin_feature	string	optional

TokenReferenceFieldSource 6 fields

Field	Type	Required	Notes
method	string	optional
path	string	optional
reference_key	string	optional
value_field	string	required
label_field	string	optional
group_field	string	optional

TokenReferenceOption 2 fields

Field	Type	Required	Notes
value	string	required
label	string	required

TokenScopeBuilder 10 fields

Field	Type	Required	Notes
preset_source	string	required
scope_source	string	required
default_preset	string	required
group_field	string	required
value_field	string	required
label_field	string	required
description_field	string	required
admin_field	string	required
destructive_field	string	required
custom_supported	boolean	required

TokenScopeMetadata 5 fields

Field	Type	Required	Notes
scope	string	required
group	string	required
description	string	required
destructive	boolean	optional
admin	boolean	optional

TriggerDefinition 7 fields

Field	Type	Required	Notes
name	string	required
scope	string	required
min_permission	string	required
context_fields	string[]	required
context_field_specs	object[]	optional
available	boolean	optional
unavailable_reason	string	optional

TriggerEnum 1 field

Field	Type	Required	Notes
No fields exposed.

U 11 schemas

UnclearBehaviorEnum 1 field

Field	Type	Required	Notes
No fields exposed.

UnitEnum 1 field

Field	Type	Required	Notes
No fields exposed.

UnsubscribeResult 1 field

Field	Type	Required	Notes
detail	string	required

UpsertLLMConfig 4 fields

Field	Type	Required	Notes
inbox_id	string	required
model	string	required
enabled_features	EnabledFeaturesEnum[]	required
budget_limit	number:double	optional

UpsertScheduledTask 5 fields

Field	Type	Required	Notes
task_name	string	optional
enabled	boolean	optional
interval_hours	number:double	optional
payload	object	optional
description	string	optional

UsageBreakdownItem 4 fields

Field	Type	Required	Notes
quantity	number:double	required
cost	number:double	required
included	integer	optional
overage	integer	optional

User 7 fields

Field	Type	Required	Notes
sub	string	required
email	string:email	required
display_name	string	required
tenant_id	string	required
role	string	required
status	string	required
created_at	string:date-time	required

UserListResponse 2 fields

Field	Type	Required	Notes
users	AdminUser[]	required
count	integer	required

UserMe 8 fields

Field	Type	Required	Notes
sub	string	required
email	string:email	required
display_name	string	required
tenant_id	string	required
role	string	required
status	string	required
created_at	string:date-time	required
next_step	string	required

UserUpdateRoleEnum 1 field

Field	Type	Required	Notes
No fields exposed.

UserUpdateStatusEnum 1 field

Field	Type	Required	Notes
No fields exposed.

V 3 schemas

ValidateInvite 6 fields

Field	Type	Required	Notes
token	string	required
tenant_id	string	required
role	string	required
email	string:email	required
batch_label	string	required
status	string	required

VerificationDetail 3 fields

Field	Type	Required	Notes
domain_id	string	required
domain	string	required
checks	object	required

VisibilityEnum 1 field

Field	Type	Required	Notes
No fields exposed.

W 51 schemas

WaitlistSubmit 1 field

Field	Type	Required	Notes
email	string:email	required

WaitlistSubmitResult 1 field

Field	Type	Required	Notes
status	string	required

WaitlistValidateResult 1 field

Field	Type	Required	Notes
email	string:email	required

WebhookConfig 3 fields

Field	Type	Required	Notes
url	string:uri	required
events	string[]	required
has_secret	boolean	required

WorkRouteCreate 14 fields

Field	Type	Required	Notes
creator_inbox_id	string	required
tenant_id	string	optional
title	string	required
description	string	optional
request_type	RequestTypeEnum	required
routing_mode	RoutingModeEnum	required
completion	CompletionEnum	required
failure_mode	object	optional
stop_on_reject	boolean	optional
source	WorkRouteSource	optional
response_detection	WorkRouteResponseDetectionConfig	optional
recipients	WorkRouteRecipient[]	required
due_at	string:date-time	required
start	boolean	optional

WorkRouteEvent 5 fields

Field	Type	Required	Notes
event_id	string	required
type	string	required
actor	string	required
created_at	string:date-time	required
details	object	required

WorkRouteEvents 1 field

Field	Type	Required	Notes
events	WorkRouteEvent[]	required

WorkRoutePlanGate 3 fields

Field	Type	Required	Notes
feature	string	required
minimum_tier	string	required
available_from_plan	string	required

WorkRouteRead 21 fields

Field	Type	Required	Notes
route_id	string	required
tenant_id	string	required
creator_inbox_id	string	required
created_by	string	required
title	string	required
description	string	required
request_type	string	required
routing_mode	string	required
completion	string	required
failure_mode	string	required
stop_on_reject	boolean	required
source	WorkRouteSource	required
response_detection	object	optional
response_instructions	string	optional
recipients	WorkRouteRecipientRead[]	required
status	string	required
due_at	string:date-time	required
created_at	string:date-time	required
updated_at	string:date-time	required
started_at	string:date-time	required
completed_at	string:date-time	required

WorkRouteRecipient 8 fields

Field	Type	Required	Notes
recipient_id	string	optional
kind	KindEnum	optional
contact_id	string	optional
email	string:email	optional
inbox_id	string	optional
role	string	optional
order	integer	optional
reminder_sequence_id	string	optional

WorkRouteRecipientRead 15 fields

Field	Type	Required	Notes
recipient_id	string	required
kind	string	required
contact_id	string	required
email	string:email	required
inbox_id	string	required
role	string	required
order	integer	required
status	string	required
reminder_sequence_id	string	required
reminder_enrollment_id	string	optional
reminder_enrollment_status	string	optional
last_reminded_at	string:date-time	optional
next_reminder_at	string:date-time	optional
completed_at	string:date-time	required
response	object	required

WorkRouteRecipientResponse 4 fields

Field	Type	Required	Notes
action	string	required
evidence	object	optional
responded_at	string:date-time	required
actor	string	required

WorkRouteReference 18 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
plan_gate	WorkRoutePlanGate	required
payload	object	required
fields	WorkRouteReferenceField[]	required
recipient_fields	WorkRouteReferenceField[]	required
recipient_kind_value_fields	object	required
response_phrase_fields	WorkRouteReferenceField[]	required
request_types	WorkRouteValueLabel[]	required
response_channels	WorkRouteValueLabel[]	required
response_detection	WorkRouteResponseDetection	required
deferred_capabilities	WorkRouteValueLabel[]	required
routing_modes	WorkRouteValueLabel[]	required
completion_rules	WorkRouteValueLabel[]	required
failure_modes	WorkRouteValueLabel[]	required
recipient_kinds	WorkRouteValueLabel[]	required
statuses	WorkRouteStatus	required
validation	WorkRouteValidation	required

WorkRouteReferenceAction 5 fields

Field	Type	Required	Notes
method	string	required
path	string	required
required_fields	string[]	optional
optional_fields	string[]	optional
auth	string	optional

WorkRouteReferenceField 16 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
required_when	object	optional
type	string	required
format	string	optional
widget	string	required
default	object	optional
defaults_by_request_type	object	optional
empty_label	string	optional
placeholder	string	optional
max_length	integer	optional
min	number:double	optional
max	number:double	optional
fields	string[]	optional
source	WorkRouteReferenceSource	optional

WorkRouteReferenceSource 2 fields

Field	Type	Required	Notes
reference_key	string	optional
value_field	string	optional

WorkRouteResponse 3 fields

Field	Type	Required	Notes
recipient_id	string	required
action	string	required
evidence	object	optional

WorkRouteResponseDetection 7 fields

Field	Type	Required	Notes
mode	string	required
detectors	string[]	required
fallback	string	required
learned_phrase_scope	string[]	required
locale_aware	boolean	required
confirmation_endpoint	string	required
route_config	object	optional

WorkRouteResponseDetectionConfig 2 fields

Field	Type	Required	Notes
phrases	object	required
unclear_behavior	object	optional

WorkRouteResponsePhrase 7 fields

Field	Type	Required	Notes
request_type	RequestTypeEnum	required
action	string	required
phrase	string	required
tenant_id	string	optional
locale	string	optional
source	string	optional
confidence	number:double	optional

WorkRouteResponsePhraseResult 9 fields

Field	Type	Required	Notes
phrase_key	string	required
tenant_id	string	required
request_type	string	required
action	string	required
locale	string	required
normalized_phrase	string	required
source	string	required
confidence	number:double	required
hit_count	integer	required

WorkRouteResponses 1 field

Field	Type	Required	Notes
responses	WorkRouteRecipientRead[]	required

WorkRouteSource 13 fields

Field	Type	Required	Notes
type	WorkRouteSourceTypeEnum	optional
id	string	optional
channel	string	optional
channel_account_id	string	optional
conversation_id	string	optional
message_id	string	optional
thread_id	string	optional
participant_mode	ParticipantModeEnum	optional
subject	string	optional
from_address	string:email	optional
title	string	optional
url	string:uri	optional
channel_event	object	optional

WorkRouteSourceTypeEnum 1 field

Field	Type	Required	Notes
No fields exposed.

WorkRouteStatus 2 fields

Field	Type	Required	Notes
routes	string[]	required
recipients	string[]	required

WorkRouteValidation 3 fields

Field	Type	Required	Notes
ordered_completion	string	required
parallel_optional	string	required
single_recipient	string	required

WorkRouteValueLabel 6 fields

Field	Type	Required	Notes
value	string	required
label	string	required
description	string	optional
actions	string[]	optional
default_role	string	optional
completion_rules	string[]	optional

WorkflowConditionBuilder 5 fields

Field	Type	Required	Notes
supports_multiple	boolean	required
combiner	string	required
field_source	string	required
field_spec_source	string	required
operators	WorkflowConditionOperator[]	required

WorkflowConditionList 6 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
workflow_tier	string	required
conditions	WorkflowConditionOperator[]	required
condition_builder	WorkflowConditionBuilder	required
counts	object	required

WorkflowConditionOperator 6 fields

Field	Type	Required	Notes
op	string	required
description	string	required
value_type	string	required
value_min	integer	optional
value_max	integer	optional
requires_llm	boolean	optional

WorkflowConditionResult 5 fields

Field	Type	Required	Notes
field	string	required
op	string	required
value	object	optional
result	boolean	required
reasoning	string	optional

WorkflowEnrichment 2 fields

Field	Type	Required	Notes
tasks	object[]	required
schemas	object[]	required

WorkflowFieldMapping 3 fields

Field	Type	Required	Notes
targets	object[]	required
public_label	string	required
description	string	required

WorkflowRecipeDiagnostic 4 fields

Field	Type	Required	Notes
level	LevelEnum	required
code	string	required
message	string	required
path	string	optional

WorkflowRecipeValidateRequest 2 fields

Field	Type	Required	Notes
toml	string	required
inputs	object	optional

WorkflowRecipeValidateResponse 10 fields

Field	Type	Required	Notes
valid	boolean	required
recipe_hash	string	required
schema_version	string	required
kind	string	required
name	string	required
description	string	optional
category	string	optional
inputs	object	required
resources	object	required
diagnostics	WorkflowRecipeDiagnostic[]	required

WorkflowReference 13 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
workflow_tier	string	required
payload	object	required
condition_builder	WorkflowConditionBuilder	required
enrichment	WorkflowEnrichment	optional
field_mapping	WorkflowFieldMapping	optional
contracts	object	optional
review_policy	WorkflowReviewPolicy	optional
triggers	TriggerDefinition[]	required
condition_ops	WorkflowConditionOperator[]	required
write_targets	WorkflowWriteTargetDefinition[]	required
write_target_compatibility	object	required

WorkflowReferencePayload 9 fields

Field	Type	Required	Notes
method	string	optional
path	string	optional
required_fields	string[]	optional
optional_fields	string[]	optional
field	string	optional
op	string	optional
value	string	optional
type	string	optional
fields	string	optional

WorkflowReviewPolicy 5 fields

Field	Type	Required	Notes
system_floor	object	required
tenant_defaults	object	required
review_modes	string[]	required
resolution_steps	string[]	required
description	string	required

WorkflowRule 14 fields

Field	Type	Required	Notes
rule_id	string	required
name	string	required
created_by	string	required
tenant_id	string	required
inbox_id	string	required
trigger	string	required
trigger_scope	string	required
trigger_min_permission	string	required
conditions	object[]	required
writes	object[]	required
enabled	boolean	required
priority	integer	required
created_at	string:date-time	required
updated_at	string:date-time	required

WorkflowRuleStats 6 fields

Field	Type	Required	Notes
rule_id	string	required
name	string	required
inbox_id	string	required
enabled	boolean	required
executions	integer	required
last_matched_at	string	required

WorkflowRuleTest 2 fields

Field	Type	Required	Notes
inbox_id	string	optional
message_id	string	optional

WorkflowRuleTestResult 6 fields

Field	Type	Required	Notes
rule_id	string	required
trigger	string	required
matched	boolean	required
context_used	object	required
conditions	WorkflowConditionResult[]	required
writes	WorkflowWritePreview[]	required

WorkflowStats 3 fields

Field	Type	Required	Notes
rules_active	integer	required
executions_total	integer	required
by_rule	WorkflowRuleStats[]	optional

WorkflowTriggerList 5 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
workflow_tier	string	required
triggers	TriggerDefinition[]	required
counts	object	required

WorkflowWritePreview 3 fields

Field	Type	Required	Notes
source	object	optional
target	object	optional
note	string	required

WorkflowWriteTargetDefinition 17 fields

Field	Type	Required	Notes
type	string	required
group	string	required
description	string	required
destructive	boolean	optional
outbound	boolean	optional
requires_llm	boolean	optional
instruction_min	integer	optional
instruction_max	integer	optional
outputs	string[]	optional
fields	WorkflowWriteTargetField[]	optional
allowed_triggers	string[]	optional
intermediary	boolean	optional
output	string	optional
input_contract	object	optional
review_policy	object	optional
available	boolean	optional
unavailable_reason	string	optional

WorkflowWriteTargetField 14 fields

Field	Type	Required	Notes
name	string	required
label	string	required
required	boolean	required
type	string	required
format	string	optional
widget	string	required
default	object	optional
placeholder	string	optional
help_text	string	optional
min_length	integer	optional
max_length	integer	optional
options	object[]	optional
source	object	optional
supports_context_variables	boolean	optional

WorkflowWriteTargetList 5 fields

Field	Type	Required	Notes
version	string	required
resource	string	required
workflow_tier	string	required
write_targets	WorkflowWriteTargetDefinition[]	required
counts	object	required

WorkflowWriteTemplate 13 fields

Field	Type	Required	Notes
template_id	string	required
name	string	required
created_by	string	required
tenant_id	string	optional
inbox_id	string	optional
description	string	optional
source	object	required
target	object	required
contract	object	optional
policy	object	optional
review_policy	object	optional
created_at	string:date-time	required
updated_at	string:date-time	required

WorkflowWriteTemplateCreate 9 fields

Field	Type	Required	Notes
name	string	required
tenant_id	string	optional
inbox_id	string	optional
description	string	optional
source	object	required
target	object	required
contract	object	optional
policy	object	optional
review_policy	object	optional

# 1 schemas

_Webhook 3 fields

Field	Type	Required	Notes
url	string:uri	required
events	string[]	optional
secret	string	optional