Skip to main content
GET
Node.js
Required scope: recipient_read Use limit, cursor and sort to page through your recipients. limit must be a positive integer; values above 100 are accepted and capped at 100. Follow pagination.nextCursor to retrieve the next page.

Authorizations

x-ledig-key
string
header
required

Your business API key ID. Keep its secret on your server and use that secret to sign each request.

x-ledig-timestamp
string
header
required

The current Unix timestamp in seconds, used in the signed request.

x-ledig-signature
string
header
required

The request's HMAC-SHA256 signature. Use the v1= prefix for supported own-business requests, or v2= when acting for a managed business with signed business-selection headers. Follow the authentication guide to construct and sign the exact request.

Query Parameters

limit
integer
default:20

Positive integer page size. Values greater than 100 are accepted and capped at 100; follow pagination.nextCursor for more results.

Required range: x >= 1
cursor
string
sort
enum<string>
Available options:
asc,
desc

Response

Recipient page.

status
string
required
Allowed value: "success"
pagination
object
required
data
object[]
required
message
string