Skip to main content
GET
/
api
/
v1
/
bots
Fetch Organisation Bots Api
curl --request GET \
  --url https://services.meetchase.ai/api/v1/bots \
  --header 'X-API-Key: <api-key>'
[
  {
    "email": "jsmith@example.com",
    "id": 123,
    "auth_data": [
      {
        "id": 123,
        "is_valid": true
      }
    ],
    "initial_volume": 123,
    "warmup_increment": 123,
    "max_daily_limit": 123,
    "cname_record": {
      "alias": "example.com",
      "id": 1,
      "valid_record": true,
      "valid_ssl": true
    },
    "shown_onboarding": true,
    "dns_validation": {
      "mx": true,
      "spf": true,
      "dkim": true,
      "dmarc": true
    },
    "custom_data": {},
    "first_name": "<string>",
    "last_name": "<string>",
    "in_pool": false,
    "warmup_started_at": "2023-11-07T05:31:56Z"
  }
]

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
required
Example:
{
  "alias": "example.com",
  "id": 1,
  "valid_record": true,
  "valid_ssl": true
}
​
mailivery_status
enum<string>
required
Available options:
PENDING_CONNECTION,
PAUSED,
ACTIVE,
CONNECTION_ERROR
​
shown_onboarding
boolean
required
​
dns_validation
DNSValidation · object
required
Example:
{
  "dns_validation": { "mx": true, "spf": false }
}
​
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