Skip to main content
GET
/
users
Listing users
curl --request GET \
  --url https://api.peeker.ai/api/partner/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "usr_01HZX0C6Z3K4M5N6P7Q8R9S0",
      "status": "active",
      "sequencer": {
        "provider": "smartlead",
        "client_id": 366903
      },
      "created_at": "2026-05-08T12:00:00Z",
      "email": "alex@acme.com",
      "first_name": "Alex",
      "last_name": "Rivera"
    }
  ],
  "links": {
    "first": "https://api.peeker.ai/api/partner/v1/domains?per_page=25",
    "next": "https://api.peeker.ai/api/partner/v1/domains?per_page=25&page_token=eyJ..."
  },
  "meta": {
    "path": "https://api.peeker.ai/api/partner/v1/domains",
    "per_page": 25,
    "returned": 25
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.peeker.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
default:Bearer pk_test_<your-test-key>
required

Your partner API key. Use pk_live_… against the live system or pk_test_… against the sandbox.

Query Parameters

​
email
string

Find a single user by email.

​
status
enum<string>

Show only active customers, or only deleted ones.

Available options:
active,
deleted
​
per_page
integer
default:25

Page size; default 25, max 100.

Required range: 1 <= x <= 100
​
page_token
string

Opaque token returned in links.next. Do not parse or build by hand.

Response

200 - application/json

A page of users.

​
data
object[]
required
​
links
object
​
meta
object
Last modified on May 14, 2026