Pagination

Springstreet supports pagination API requests to retrieve larger lists of information.

To ensure fast and reliable performance, the Springstreet API uses pagination to handle large sets of results. Instead of returning thousands of records in a single response, the API delivers data in "pages." Your application will need to make subsequent requests to retrieve each page until all results have been received.

Pagination is controlled by a simple page number token system.

Requesting a Specific Page

To request a specific page of results, include the pagination_token field in your POST request body.

Field
Type
Required
Description

pagination_token

integer

No

The page number you wish to retrieve. If omitted, the API will default to page 1.

Example Request for Page 1

To get the first page of results, you can either omit the token or explicitly set it to 1.

{
  "secured_party_name": "JPMORGAN CHASE BANK NA",
  "jurisdiction_state": "UT"
}

Reading the Response

Every successful response will contain a response_metadata object. Inside this object, the next_pagination_token field tells you how to retrieve the next page.

Field
Type
Description

next_pagination_token

integer | null

The page number for the next set of results. If this value is null, you have reached the last page and there are no more results to fetch.

Example Response for Page 1

After making the first request, the response indicates that the next page is 2.

{
    "primary_creditor": { ... },
    "ucc_liens": [
        // ... 5 lien results for page 1
    ],
    "response_metadata": {
        "timestamp": "2025-06-29T21:45:00.123456Z",
        "request_id": "b4a3c2d1-e5f6-7890-1234-abcdef123456",
        "next_pagination_token": 2
    }
}

Retrieving Subsequent Pages

To get the next set of results, simply make a new POST request and use the next_pagination_token value from your previous response as the new pagination_token.

Example Request for Page 2

Using the 2 from the previous response's next_pagination_token:

{
  "secured_party_name": "JPMORGAN CHASE BANK NA",
  "jurisdiction_state": "UT",
  "pagination_token": 2
}

You should continue this process, making new requests with the updated pagination_token, until the next_pagination_token in the response is null.

Last updated