Skip to main content
GET
Search Sender Profiles

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

query
string
required
limit
integer
default:20

Response

Successful Response

user_id
string
required

User ID who owns this profile

profile_name
string
required

User-friendly name for this profile (e.g., 'Sales Team Profile', 'Personal Brand')

Required string length: 1 - 100
sender_data
DynamicSenderData · object
required

The actual sender data with arbitrary fields

id
string | null

Unique profile identifier

description
string | null

Optional description of when/how to use this profile

Maximum string length: 500
prompt_names
string[]

Names of saved prompts on this profile (from sender_data.prompts[].name). Body/text intentionally omitted from list/search responses to keep payloads light and avoid leaking long prompt bodies into the campaign launcher.

created_at
string<date-time> | null

Profile creation timestamp

updated_at
string<date-time> | null

Last update timestamp

usage_count
integer
default:0

Number of times this profile has been used

is_default
boolean
default:false

Whether this is the default profile

send_mechanism
enum<string>
default:bavimail

Outbound send mechanism bound to this sender identity.

Available options:
bavimail,
gmail,
outlook
connected_mailbox_account
string | null

Connected mailbox account key, e.g. the Gmail address.