Pagination

Most List endpoints support offset pagination to allow bulk fetching multiple items. Each List endpoint shares a common response structure. Examples of these requests can be seen in List Applications and List Tokens.

The List Logs endpoint supports cursor pagination.

Most SDKs offer autopagination for both offset and cursor based paginations. Simply make one call to get the start of the list and iterate through the list as normal. The SDK will make additional requests as necessary to pull more data.

Offset Pagination

Request

cURL

curl "https://api.basistheory.com/applications?page=2&size=10" \
-H "BT-API-KEY: <API_KEY>"

Node

const tokens = await client.tokens.list({
    page: 1,
    size: 10
});

for await (const token of tokens) {
    ...
}

JavaScript (legacy)

import {BasisTheory} from "@basis-theory/basis-theory-js";

const bt = await new BasisTheory().init("<MANAGEMENT_API_KEY>");

const applications = await bt.applications.list({
  page: 2,
  size: 10,
});

C#

var tokens = client.Tokens.ListAsync(new TokensListRequest
  {
    Page = 1,
    Size = pageSize
  }, null
);

await foreach (var token in tokens)
{
  ...
}

Python

tokens = client.tokens.list(size=10, page=1)

for count, token in enumerate(tokens, start=1):
  ...

Go

pageNum := 1
pageSize := 3
page, err := client.Tokens.List(
    context.TODO(),
    &basistheory.TokensListRequest{
        Page: &pageNum,
        Size: &pageSize,
    },
)

iter := page.Iterator()
for iter.Next(context.TODO()) {
  ...
}

Query Parameters

Parameter	Required	Type	Default	Description
page	false	integer	1	Page number of the results to return.
size	false	integer	20	Number of results per page to return. Maximum size of 100 results.

Response

{
  "pagination": {
    "total_items": 924,
    "page_number": 2,
    "page_size": 10,
    "total_pages": 93
  },
  "data": [
    {...},
    {...},
    {...}
  ]
}

Offset Pagination Object

Attribute	Type	Description
pagination	offset pagination metadata	Pagination metadata for the response
data	array	Query results of the request. See list endpoint resource for response schema definition

Offset Pagination Metadata Object

Attribute	Type	Description
total_items	integer	Total number of items in the Tenant
page_number	integer	Current page number. Should match page query parameter.
page_size	integer	The size of each page. Should match size query parameter.
total_pages	integer	The total number of pages.

Cursor Pagination

Request

cURL

curl "https://api.basistheory.com/logs?start=AAAAAAAAAAAAAAAABBBBBBBBBBBBBBCCCCCCCCCCDDDDDDDDDD&size=10" \
-H "BT-API-KEY: <API_KEY>"

Node

const tokens = await client.tokens.listV2({
    size: pageSize,
});

for await (const token of tokens) {
    ...
}

JavaScript (legacy)

import {BasisTheory} from "@basis-theory/basis-theory-js";

const bt = await new BasisTheory().init("<MANAGEMENT_API_KEY>");

const logs = await bt.logs.list({
  start: 'AAAAAAAAAAAAAAAABBBBBBBBBBBBBBCCCCCCCCCCDDDDDDDDDD',
  size: 10,
});

C#

var tokens = client.Tokens.ListV2Async(new TokensListV2Request
  {
    Size = pageSize
  }, null
);

await foreach (var token in tokens)
{
  ...
}

Python

tokens = client.tokens.list_v2(size=10)

for count, token in enumerate(tokens, start=1):
  ...

Go

pageSize := 3
page, err := client.Tokens.ListV2(
  context.TODO(),
  &basistheory.TokensListV2Request{
    Start: nil,
    Size:  &pageSize,
  },
)

iter := page.Iterator()
for iter.Next(context.TODO()) {
  ...
}

Query Parameters

Parameter	Required	Type	Default	Description
start	false	string	null	Cursor provided in the previous query to get the next set of results.
size	false	integer	20	The maximum number of results to return. Maximum size of 100 results.

Response

{
  "pagination": {
    "next": "AAAAAAAAAAAAAAAABBBBBBBBBBBBBBCCCCCCCCCCDDDDDDDDDD",
    "page_size": 10
  },
  "data": [
    {...},
    {...},
    {...}
  ]
}

Cursor Pagination Object

Attribute	Type	Description
pagination	cursor pagination metadata	Pagination metadata for the response
data	array	Query results of the request. See list endpoint resource for response schema definition

Cursor Pagination Metadata Object

Attribute	Type	Description
next	string	Cursor to get the next set of results.
page_size	integer	The maximum number of results returned. Should match size query parameter.