Skip to main content

Pagination

The Capital Check In API uses cursor-based pagination for endpoints that return lists of resources.

Pagination Parameters

When making requests to endpoints that support pagination, you can use the following query parameters:
ParameterTypeDescription
limitintegerNumber of items to return (default: 20, max: 100)
cursorstringCursor for pagination (returned in previous response)

Example Request

GET /collaborators?limit=10&cursor=eyJpZCI6MTIzfQ==

Response Format

Paginated responses include pagination metadata:
{
  "data": [
    // Array of resources
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "eyJpZCI6MjM0fQ==",
    "total": 150
  }
}

Pagination Metadata

FieldTypeDescription
hasMorebooleanWhether there are more items available
nextCursorstringCursor for the next page (null if no more pages)
totalintegerTotal number of items (if available)

Best Practices

  • Use appropriate limit values based on your needs
  • Always check hasMore before making additional requests
  • Store the nextCursor for subsequent requests
  • Handle cases where nextCursor is null (end of results)