Peeker Partner API

GET

/

workspaces

List workspaces

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

{
  "data": [
    {
      "workspace_id": "wrk_01HZX0WK1A2B3C4D5E6F7G8H",
      "name": "Acme PlusVibe",
      "provider": "plusvibe",
      "provider_workspace_id": "692577ed8543f416f83ad252",
      "status": "active",
      "created_at": "2026-07-09T12:00:00.000Z",
      "updated_at": "2026-07-09T12:00:00.000Z",
      "client_id": "366903",
      "label": "Agency Smartlead",
      "customer": {
        "customer_id": "cus_01HZX0C6Z3K4M5N6P7Q8R9S0",
        "reference": "customer-42",
        "status": "active",
        "name": "Acme",
        "email": "ops@acme.com"
      }
    }
  ],
  "links": {
    "first": "https://api.peeker.ai/partner/v1/domains?per_page=25",
    "next": "https://api.peeker.ai/partner/v1/domains?per_page=25&page_token=eyJ..."
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/domains",
    "per_page": 25,
    "returned": 25
  }
}

{
  "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

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

Provider workspaces owned by this partner.

data

object[]

required

Show child attributes

links

object

required

Show child attributes

meta

object

required

Show child attributes

Last modified on October 5, 2026

List workspaces

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

{
  "data": [
    {
      "workspace_id": "wrk_01HZX0WK1A2B3C4D5E6F7G8H",
      "name": "Acme PlusVibe",
      "provider": "plusvibe",
      "provider_workspace_id": "692577ed8543f416f83ad252",
      "status": "active",
      "created_at": "2026-07-09T12:00:00.000Z",
      "updated_at": "2026-07-09T12:00:00.000Z",
      "client_id": "366903",
      "label": "Agency Smartlead",
      "customer": {
        "customer_id": "cus_01HZX0C6Z3K4M5N6P7Q8R9S0",
        "reference": "customer-42",
        "status": "active",
        "name": "Acme",
        "email": "ops@acme.com"
      }
    }
  ],
  "links": {
    "first": "https://api.peeker.ai/partner/v1/domains?per_page=25",
    "next": "https://api.peeker.ai/partner/v1/domains?per_page=25&page_token=eyJ..."
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/domains",
    "per_page": 25,
    "returned": 25
  }
}

{
  "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": {}
  }
}