Maintenance required - Friday January 22nd 12pm (PT)

Support Central will be briefly offline on Friday January 22nd from 12:00 pm (PT) while we make improvements and upgrades to this site.

You are here

Upcoming changes to FULL search in Mail and Documents API

Monday, 20 April, 2020

In an effort to improve efficiency of individual API requests and reduce the impact on overall system performance, we will be deprecating the ability to do an unbounded search of the whole Mail and Documents register in a single API query (search_type: FULL). Expected date of deprecation is 30 July 2020.

We are advising all users who’ve been using the FULL search_type to move to the PAGED search_type instead (max page_size is set to 500).
This will require code changes in your integration application to replace your FULL search_type query to paginated requests to avoid disruptions in your automation.

These are the APIs that will be impacted is search_type=FULL is used in the {parameters} list:
* List Documents Service/API: HTTP GET: https://{hostname}/api/projects/{projectid}/register?{parameters}
* List Mail Service/API: HTTP GET: https://{hostname}/api/projects/{projectid}/mail?{parameters}