Collections
...
Collections API
Requests

List Requests

8min

List Requests

You can List the Requests for a Collection by making making a HTTP GET request to the /collections/COLLECTION_ID/requests/PAGE endpoint (where COLLECTION_ID is the id of the Collection to get Requests for, and PAGE is the page of Requests to get).

The /collections/COLLECTION_ID/requests/PAGE endpoint returns the Requests for a Collection in pages of 1000 Requests per page. Pages start at 1 . You can find out how many pages a Collection has by inspecting the requests_page_count field returned from the Get Collection endpoint.

Backyard API also provides two more endpoints to allow you to retrieve a download link for all Requests in a Collection, in either JSON or CSV format.



List Requests by Page

GET /collections/COLLECTION_ID/requests/PAGE

In the example below we List page 1 of the Requests for the Collection with id=123456 :

HTTP
Curl
Node.js
Python
PHP


Backyard API responds with the following JSON showing all the Requests on page 1 of the Collection:

JSON



Get JSON Download Links

GET /collections/COLLECTION_ID/requests/json

In the example below we retrieve download links for all Requests for Collection with id=123456 in JSON format:

HTTP
Curl
Node.js
Python
PHP


Backyard API responds with the following JSON detailing the total number of Requests requests_total_count , the total number of pages requests_page_count and a JSON file download_link for each page:

JSON



Get CSV Download Links

GET /collections/COLLECTION_ID/requests/csv

In the example below we retrieve download links for all Requests for Collection with id=123456 in CSV format:

HTTP
Curl
Node.js
Python
PHP


Backyard API responds with the following JSON detailing the total number of Requests requests_total_count , the total number of pages requests_page_count and a CSV file download_link for each page:

JSON



Next Steps      Listing Result Sets      Getting Result Sets

Updated 08 Aug 2024
Did this page help you?