SHshutterstock
videos

Get the details of video collections

Changed on

This endpoint gets more detailed information about a collection, including the timestamp for its creation and the number of videos in it. To get the videos in collections, use GET /v2/videos/collections/{id}/items.

get/v2/videos/collections/{id}

Request

Path parameters

idstring required

The ID of the collection to return

Query parameters

embedstring[]

Which sharing information to include in the response, such as a URL to the collection

share_codestring

Code to retrieve a shared collection

Response

OK

created_timestring date-time

When the collection was created

idstring required

The collection ID

items_updated_timestring date-time

The last time this collection's items were updated

namestring required

The name of the collection

share_codestring

A code that can be used to share the collection (optional)

share_urlstring

The browser URL that can be used to share the collection (optional)

total_item_countinteger required

The number of items in the collection

updated_timestring date-time

The last time the collection was updated (other than changes to the items in it)

Example response

{
  "id": "293542904",
  "name": "My collection",
  "total_item_count": 85,
  "items_updated_time": "2021-05-20T16:15:22-04:00",
  "cover_item": {
    "id": "297886754"
  }
}

Changes

  • d2e03e7f655dRevision changes
    • info

      api operation id getClipbox removed and replaced with getVideoCollection

    • info

      added the new optional query request parameter embed

    • info

      added the new optional query request parameter share_code

    • info

      added the non-success response with the status