Skip to main content
GET
List agent-prefixed API-key metadata (Admin)

Authorizations

x-api-key
string
header
required

Your Recoup API key. Learn more.

Query Parameters

period
enum<string>
default:all

Optional key-record creation window, inclusive from 00:00 UTC: daily = today; weekly = 7 calendar days including today; monthly = 30 calendar days including today; all = no cutoff. Defaults to all when omitted; an explicit empty or unsupported value returns 400. This is not a rolling 24-hour window and does not filter by account or email creation time.

Available options:
all,
daily,
weekly,
monthly

Response

Returned API-key metadata and the count of these returned records.

status
enum<string>
required
Available options:
success
total
integer
required

Number of key records in this returned signups array. Not a separate database-wide count or a count of unique accounts, agents, active keys or adoption.

Required range: x >= 0
signups
object[]
required

Returned metadata rows ordered by key-record created_at descending. The retained wire name does not establish signup origin. Multiple keys for one account remain separate rows.