Skip to main content
GET
List user recipient book

Authorizations

X-API-Key
string
header
required

Your partner API key. Use raas_sandbox_* keys for the sandbox environment and raas_live_* keys for production.

Path Parameters

userId
string
required

M2M user identifier

Example:

"user_acme_x1y2z3"

Query Parameters

limit
string

Max recipients returned (1-50, default 50)

Example:

50

Response

Recent recipients retrieved successfully

recipientKey
string
required

Stable aggregation key (recipient fingerprint)

Example:

"fp_9a3c1d5e9f02b4d6e8f01a2b"

name
object
required
lastUsedAt
string
required
Example:

"2026-07-01T12:00:00.000Z"

timesUsed
number
required
Example:

7

destinations
object[]
required
address
object
phone
string
Example:

"+5213312345678"