Peeker Partner API

GET

bundles

List bundles

curl --request GET \
  --url https://api.peeker.ai/partner/v1/bundles \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "bun_01HZX0BU1A2B3C4D5E6F7G8H",
      "name": "Starter 25k emails/month",
      "monthly_sending_volume": 25000,
      "google_percent": null,
      "microsoft_percent": null,
      "send_on_weekends": false,
      "google_licenses": 2,
      "status": "active",
      "effective": {
        "google_percent": 50,
        "microsoft_percent": 50
      },
      "required_domains": {
        "google": 15,
        "microsoft": 4,
        "total": 19
      },
      "created_at": "2026-05-08T12:00:00Z"
    },
    {
      "id": "bun_01HZX0BU2A2B3C4D5E6F7G8H",
      "name": "Pro 100k emails/month",
      "monthly_sending_volume": 100000,
      "google_percent": 70,
      "microsoft_percent": 30,
      "send_on_weekends": false,
      "google_licenses": 2,
      "status": "active",
      "effective": {
        "google_percent": 70,
        "microsoft_percent": 30
      },
      "required_domains": {
        "google": 80,
        "microsoft": 10,
        "total": 90
      },
      "created_at": "2026-04-01T10:00:00Z"
    }
  ],
  "links": {
    "first": "https://api.peeker.ai/partner/v1/bundles?per_page=25",
    "next": null
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/bundles",
    "per_page": 25,
    "returned": 2
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

Authorizations

Authorization

string

header

default:Bearer pk_test_<your-test-key>

required

Partner API key (pk_live_… or pk_test_…).

Query Parameters

status

enum<string>

active or archived.

Available options:

active,

archived

per_page

integer

default:25

How many rows per page (default 25, max 100).

Required range: 1 <= x <= 100

page_token

string

Opaque signed token from the page_token query parameter of links.next. Prefer requesting the complete links.next URL directly; it is a URL, not a token. GET /orders also accepts that complete next-page URL as this parameter's value. When passing a token or URL in this parameter, keep the same list filters. Stop when links.next is null; do not send the strings "null" or "undefined".

Response

A page of bundles.

data

object[]

required

Show child attributes

links

object

Show child attributes

meta

object

Show child attributes

Last modified on October 5, 2026

List bundles

curl --request GET \
  --url https://api.peeker.ai/partner/v1/bundles \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "bun_01HZX0BU1A2B3C4D5E6F7G8H",
      "name": "Starter 25k emails/month",
      "monthly_sending_volume": 25000,
      "google_percent": null,
      "microsoft_percent": null,
      "send_on_weekends": false,
      "google_licenses": 2,
      "status": "active",
      "effective": {
        "google_percent": 50,
        "microsoft_percent": 50
      },
      "required_domains": {
        "google": 15,
        "microsoft": 4,
        "total": 19
      },
      "created_at": "2026-05-08T12:00:00Z"
    },
    {
      "id": "bun_01HZX0BU2A2B3C4D5E6F7G8H",
      "name": "Pro 100k emails/month",
      "monthly_sending_volume": 100000,
      "google_percent": 70,
      "microsoft_percent": 30,
      "send_on_weekends": false,
      "google_licenses": 2,
      "status": "active",
      "effective": {
        "google_percent": 70,
        "microsoft_percent": 30
      },
      "required_domains": {
        "google": 80,
        "microsoft": 10,
        "total": 90
      },
      "created_at": "2026-04-01T10:00:00Z"
    }
  ],
  "links": {
    "first": "https://api.peeker.ai/partner/v1/bundles?per_page=25",
    "next": null
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/bundles",
    "per_page": 25,
    "returned": 2
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

Account

Provider workspaces

Bundles

Domains

Domain pool

Orders

Domain swaps

List bundles

Authorizations

Query Parameters

Response