The NAM API uses cursor based pagination. Some endpoints using the List verb include pagination parameters in the request input and return paginated data in the output.

  • For the input, paginated endpoints have a parameter called pagination_parameters, which includes two fields page_size and cursor.
    • cursor is an optional input for which object to start querying results from; if null then results are returned from the beginning
    • page_size is a required input, representing how many objects to return in the page. The maximum allowed value for page_size is 500.
  • The response payload returns a page_info object containing fields for end_cursor (nullable) and page_size
    • If end_cursor is not null, that means there are more results to query for else if null then all the data has been returned.