Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

The data.access_token value from Get access token.

x-api-key
string
header
required

API key issued by Kira.

Headers

X-Api-Version
string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-04-14"

Query Parameters

user_id
string<uuid>
required

The user whose recipients you want.

Example:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

metadata
object

Return only the recipients carrying the metadata you name, in the ?metadata[key]=value form. Pass more than one key to require all of them.

Each key is 1 to 40 characters and cannot contain [ or ].

Response

Success.

recipients
object[]
total
integer

How many recipients came back. There is no paging on this call, so it is the length of recipients.