Skip to main content
POST
Search a pool for bookable slots with offer tokens

Authorizations

x-api-key
string
header
required

API key from Settings > API Keys or POST /v1/api-keys. Format f9_live_<32 hex chars> (live) or f9_test_<32 hex chars> (sandbox — no real sends, ever). Legacy wcrm_live_ / wcrm_test_ keys still authenticate but are no longer issued. Shown once at creation; only a hash is stored.

Body

application/json
pool_id
string<uuid>
required
policy_id
string<uuid>

Defaults to the workspace default policy.

from
string<date-time>
to
string<date-time>

At most 31 days after from; capped to the policy horizon.

count
integer

Defaults to the policy's offer count.

Required range: 1 <= x <= 20
must_include_users
string<uuid>[]
exclude_users
string<uuid>[]
attendee_timezone
string | null

Response

Search completed

success
enum<boolean>
Available options:
true
data
object
meta
object