Skip to main content
GET
Fetch Organisation Bots Api

Authorizations

X-API-Key
string
header
required

Key used to authenticate user API requests.

Response

200 - application/json

Successful Response

email
string<email>
required
id
integer
required
auth_data
ExternalAuthData · object[]
required
initial_volume
integer
required
warmup_increment
integer
required
max_daily_limit
integer
required
cname_record
CNAMERecord · object | null
required
Example:
mailivery_status
enum<string>
required
Available options:
PENDING_CONNECTION,
PAUSED,
ACTIVE,
CONNECTION_ERROR
shown_onboarding
boolean
required
dns_validation
DNSValidation · object
required
Example:
status
enum<string>
required
Available options:
ACTIVE,
CANCELLED,
CONFIGURING,
CONNECTION_PENDING,
COOLING_OFF,
INACTIVE,
DELETED,
PROVISIONING,
PROVISIONING_FAILED,
SCHEDULED_FOR_CANCELLATION,
SUSPENDED,
PAYMENT_FAILED
source
enum<string>
required
Available options:
INBOXKIT,
CUSTOMER
custom_data
Custom Data · object
first_name
string | null
Maximum string length: 63
last_name
string | null
Maximum string length: 63
in_pool
boolean
default:false
warmup_started_at
string<date-time> | null