Get Collection

4min

Get Collection
You can get a Collection by making making a HTTP GET request to the /collections/COLLECTION_ID endpoint (where COLLECTION_ID is the id of the Collection you wish to get).
Backyard API will return all information about the Collection, including whether it is currently running and how many Requests and Results Sets the Collection currently has.
Note that the Collection Get endpoint just returns counts of the number of Requests and Result Sets the Collection contains. If you wish to retrieve the actual Requests or Result Sets in the Collection you should use the List Requests and List Result Sets endpoints.
﻿
Example
﻿GET  /collections/COLLECTION_ID
In the example below we Get a Collection with id=123456 :
HTTP
Curl
Node.js
Python
PHP
https://api.backyardapi.com/collections/123456?api_key=demo
https://api.backyardapi.com/collections/123456?api_key=demo
﻿
Backyard API responds with the following JSON showing all details of the Collection:
JSON
{
  "request_info": {
    "success": true
  },
  "collection": {
    "id": "123456",
    "created_at": "2020-01-01T00:00:00.000Z",
    "name": "My First Collection",
    "schedule_type": "manual/daily/weekly/monthly",
    "priority": "normal",
    "destination_ids": [
      "destination_id_1",
      "destination_id_2"
    ],
    "enabled": true,
    "status": "idle/queued/running",
    "request_total_count": 0,
    "request_page_count": 0,
    "credits_required": 0,
    "next_result_set_id": 1,
    "results_count": 0,
    "schedule_hours": [
      9,
      17
    ],
    "notification_email": "[email protected]",
    "notification_as_json": false,
    "notification_as_jsonlines": false,
    "notification_as_csv": true
  }
}
{
  "request_info": {
    "success": true
  },
  "collection": {
    "id": "123456",
    "created_at": "2020-01-01T00:00:00.000Z",
    "name": "My First Collection",
    "schedule_type": "manual/daily/weekly/monthly",
    "priority": "normal",
    "destination_ids": [
      "destination_id_1",
      "destination_id_2"
    ],
    "enabled": true,
    "status": "idle/queued/running",
    "request_total_count": 0,
    "request_page_count": 0,
    "credits_required": 0,
    "next_result_set_id": 1,
    "results_count": 0,
    "schedule_hours": [
      9,
      17
    ],
    "notification_email": "john.smith@example.com",
    "notification_as_json": false,
    "notification_as_jsonlines": false,
    "notification_as_csv": true
  }
}
﻿
﻿
Next Steps
     List Requests
     List Result Sets﻿

Updated 08 Aug 2024

Did this page help you?

Delete Collection

List Collections