We are introducing changes to files related API endpoints.

What is changing?

Reducing max page size (`limit` parameter) from 500 to 100 for the following endpoints:

• GET v1/files
• GET v1/deals/{id}/files
• GET v1/organizations/{id}/files
• GET v1/persons/{id}/files

If a client passes a limit higher than 100, no error will be returned and the API will treat it as if 100 was passed.

Default page size remains 100. Requests without limit param specified will return up to 100 items.

Why is it changing?

To improve the stability and performance of the endpoints and reduce impact on other parts of the system.

Migration guide

If you are specifying a limit larger than 100, please migrate to new max limit of 100.

Alternatively, do not send a limit altogether to rely on the default limit of 100. If you are not paginating the results and just grabbing the first page, it is recommended to properly paginate the results in case there is more than 100 files in the response.

Pseudocode example properly paginating the results:

        
  limit = 100  # Alternatively omit the limit (it will default to 100)
  start = 0

  do {
    response = fetch_files(start, limit)
    # process files here ...  

    start = response.additional_data.pagination.next_start
  }
  while (response.additional_data.pagination.more_items_in_collection)

        

If you have any questions or comments, feel free to let us know in the Developer’s Community.