Documents on a blue background with the words Release NOtes

Release Notes: DocumentCloud API updates and embargo restructuring

Written by
Edited by Samantha Sunne

DocumentCloud

A few key changes have been made to the DocumentCloud API to make it easier for developing new tools.

  • Add-On runs may now be filtered by an Add-On ID, allowing you to narrow your search for the specific run of an Add-On without doing post-query filtering.

  • The projects endpoint now includes two new filters: Shared and Owned. Setting is_shared to True will return only the projects that are shared with the currently authenticated user. Setting is_owned to True will return only the projects that are owned by the currently authenticated user. It will exclude projects that the user is a collaborator on.

MuckRock

For the MuckRock API, embargoes are now restructured. Previously, when filtering requests you could filter by embargo or permanent_embargo. Now, you must filter by embargo_status with a few options: public, embargo or permanent embargo. Similarly, if you are updating a request with a PATCH request, the same fields above for embargo_status apply. Finally, if you are retrieving a request’s details with a GET, the response will now include an embargo_status set to one of these three options. To get started with the MuckRock API, consult our guide on making requests in batches.