PaginatedResourceResponse

An interface that describes the response of a method that returns a paginated list of resources.

Properties

Properties	Type	Description
data	T[]	An array that contains the fetched data.
totalCount	number	The total count of data that exist remotely.

Returns

If the promise resolves, you will get back the properties listed above. data will be an array of the resource type you requested. You can use the totalCount property to determine how many total items exist remotely.

Some methods that return this type allow pagination with the limit and offset parameters, in which case the first 10 items will be returned by default. For methods such as getAllowlistIdentifierList(), which do not take a limit or offset, all items will be returned.

If the promise is rejected, you will receive a ClerkAPIResponseError or network error.