IRironcladapp
Search

Get Search Result Set Page

Changed on

Retrieve a paginated window of records from a search result set created by conversational_search. When conversational_search finds a large number of matching records, it returns a resultSetId in its pagination block. Use this endpoint to page through the full result set.

OAuth Scopes required: public.search.conversational, public.records.readRecords, public.workflows.readWorkflows

get/search/result-sets/{resultSetId}

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/search/result-sets/{resultSetId}
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.search.conversational, public.records.readRecords, public.workflows.readWorkflows

Path parameters

resultSetIdstring required

The result set identifier returned by conversational_search in pagination.resultSetId

Query parameters

pageinteger

The page number to retrieve, starting at 0. Defaults to 0.

pageSizeinteger

Number of records per page. Defaults to 50, maximum 100.

Response

A page of records from the result set

resultSetIdstring required

The result set identifier

pageinteger required

The page number returned, starting at 0.

pageSizeinteger required

The number of records per page

totalCountinteger required

How many records matched the search. This can be larger than servableCount (see there for why), so page with hasMore rather than counting up to this value.

servableCountinteger required

How many of the matching records this endpoint can return. It is lower than totalCount in two cases: a result set saved as a fixed list of records keeps only the first records up to a storage limit (currently 200), and a very large live result set can be paged only through its first 10,000 records. hasMore becomes false once these are exhausted.

hasMoreboolean required

Whether another page exists. Stop when false.

nextPageinteger nullable required

The page number to request next (page + 1), or null when there are no more pages. Returned so callers, including AI agents, do not have to compute it.

Changes