Navigate...

K

List Distributions

sdk.distributions.list(params?)

Retrieve all distributions for your project with pagination. Use this to browse distribution history, monitor active distributions, or find a specific distribution by name. Results are sorted by creation date by default.

API key required to run methods

API Key *

Don't have an API key?Get one at dashboard.multisender.app

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 distributions 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

ASC
DESC

Order Dir (optional)

Returns

PaginatedResponse<Distribution>

Paginated list of distribution objects

data

Distribution[]

Array of distribution objects for the current page

meta.total

number

Total number of distributions matching the query

meta.page

number

Current page number

meta.limit

number

Items per page

meta.totalPages

number

Total number of pages

Errors

401

The request is not authorized

403

You do not have permission to access this resource

See Also

distribute()

Create a new distribution

Previous

Distributions

Next

get()

Generated Code