Navigate...
List Lists
sdk.lists.list(params?)
Retrieve all recipient lists for your project with pagination. Use this to browse available lists before creating a distribution, or to find a list by name.
API key required to run methods
API Key *
Base URL
params.page
number
optional
Page number (default: 1)
Page (optional)
params.limit
number
optional
Items per page (default: 10)
Limit (optional)
params.search
string
optional
Filter lists by name
Search (optional)
params.orderBy
string
optional
Field to sort by (e.g. createdAt)
Order By (optional)
params.orderDir
'ASC' | 'DESC'
optional
Sort direction
Order Dir (optional)
Returns
PaginatedResponse<RecipientList>
Paginated list of recipient list objects
data
RecipientList[]
Array of recipient list objects
meta.total
number
Total number of lists
meta.page
number
Current page number
meta.limit
number
Items per page
meta.totalPages
number
Total number of pages
Errors
The request is not authorized
You do not have permission to access this resource
See Also
get()
Get details for a specific list by ID
createDistributionList()
Create a new list with recipients
Generated Code