Navigate...
Get Recipients
sdk.lists.getRecipients(listId, params?)
Retrieve recipients (list items) in a list with pagination. Each item includes the linked recipient with wallet address, address type, label, and the amount and tags assigned in this list.
API key required to run methods
API Key *
Base URL
listId
string
required
List ID
List ID
params.page
number
optional
Page number (default: 1)
Page (optional)
params.limit
number
optional
Items per page (default: 10)
Limit (optional)
params.orderBy
string
optional
Field to sort by
Order By (optional)
params.orderDir
'ASC' | 'DESC'
optional
Sort direction
Order Dir (optional)
Returns
PaginatedResponse<ListItem>
Paginated list items with nested recipient details
data[].id
string
List item identifier
data[].listId
string
Parent list ID
data[].recipientId
string
Linked recipient ID
data[].amount
string | null
Token amount for this recipient
data[].tags
string[]
Tags assigned to this entry
data[].recipient.id
string
Recipient ID
data[].recipient.address
string
Wallet address
data[].recipient.addressType
string
EVM (currently supported) | SOLANA | TRON | MOVE_EVM | TON (coming soon)
data[].recipient.label
string | null
Human-readable label
data[].recipient.metadata
object | null
Arbitrary metadata
data[].createdAt
string
ISO 8601 creation timestamp
meta.total
number
Total recipients in this list
meta.page
number
Current page
meta.totalPages
number
Total pages
Errors
Invalid list id
The request is not authorized
You do not have permission to access this resource
List not found
See Also
addRecipient()
Add a new recipient to this list
removeListItem()
Remove an item by ID
get()
Get the list metadata and total count
Generated Code