List Recipients
GET /v2/send/recipients
GET
/v2/send/recipients
List recipients with pagination and optional userId filtering
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” number
required
number
Page number (starts at 1)
Example
1 size
required
number
Items per page
Example
10 totalPages
required
number
Total number of items
Example
100 totalCount
required
number
Total number of pages
Example
10 hasNext
required
boolean
Whether there is a next page
Example
true hasPrev
required
boolean
Whether there is a previous page
userId
string format: uuid
Filter by external user ID
Example
e271bc5c-f870-44cd-8462-54280d0411f6 page[number]
number
Page number (starts at 1)
Example
1 page[size]
number
Items per page
Example
10Header Parameters
Section titled “Header Parameters ” X-API-Key
string
API Key
X-API-Secret
string
API Secret
Responses
Section titled “ Responses ”Paginated list of recipients
object
items
required
List of recipients
Array<object>
object
id
required
Recipient ID
string format: uuid
e271bc5c-f870-44cd-8462-54280d0411f6 organisationId
required
Organisation ID
string format: uuid
userId
required
User ID
string format: uuid
displayNickName
required
Display nickname for recipient
string
John tokenizationId
required
Tokenization ID from Aegis vault
string
bankDetails
required
Bank details (detokenized)
object
createdAt
required
Created at
string format: date-time
updatedAt
required
Updated at
string format: date-time
page
required
Pagination info
object
number
required
Page number (starts at 1)
number
1 size
required
Items per page
number
10 totalPages
required
Total number of items
number
100 totalCount
required
Total number of pages
number
10 hasNext
required
Whether there is a next page
boolean
true hasPrev
required
Whether there is a previous page
boolean
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error