Skip to main content

Pagination

List endpoints return paginated results. By default, pages contain up to 50 records.

Query parameters

ParameterTypeDescription
page_sizeintegerNumber of records per page (max: 100)
page_tokenstringToken for the next page (from previous response)

Paginated response

{
"data": [...],
"meta": {
"page": 1,
"page_size": 50,
"total": 234,
"next_page_token": "tok_abc123",
"previous_page_token": null
}
}

Iterating through pages

let pageToken = null;

do {
const response = await client.messages.list({
pageSize: 50,
pageToken,
});

for (const message of response.data) {
console.log(message.sid);
}

pageToken = response.meta.next_page_token;
} while (pageToken);