Sign in

v1

latestOpenAPI 3.0.02026-07-131091452.6 MB
images

Get the details of image collections

This endpoint gets more detailed information about a collection, including its cover image and timestamps for its creation and most recent update. To get the images in collections, use GET /v2/images/collections/{id}/items.

get/v2/images/collections/{id}

Path parameters

idstring required

Collection ID

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 update (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"
  }
}