Get the contents of image collections

v1.0.0

This endpoint lists the IDs of images in a collection and the date that each was added.

Input

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "page": {
      "type": "integer"
    },
    "per_page": {
      "type": "integer"
    },
    "share_code": {
      "type": "string"
    },
    "sort": {
      "type": "string",
      "enum": [
        "newest",
        "oldest"
      ]
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Output

{
  "description": "List of items in a collection",
  "properties": {
    "data": {
      "type": "array",
      "description": "Assets in the collection",
      "items": {
        "type": "object",
        "description": "Metadata about an item that is part of a collection",
        "required": [
          "id"
        ],
        "properties": {
          "added_time": {
            "type": "string",
            "format": "date-time",
            "description": "The date the item was added to the collection"
          },
          "id": {
            "type": "string",
            "description": "ID of the item"
          },
          "media_type": {
            "type": "string",
            "description": "The media type of the item, such as image, video, or audio"
          }
        }
      }
    },
    "errors": {
      "type": "array",
      "description": "Error list; appears only if there was an error",
      "items": {
        "type": "object",
        "description": "Error object",
        "required": [
          "message"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "The error code of this error"
          },
          "data": {
            "type": "string",
            "description": "Debugging information about the error"
          },
          "items": {
            "type": "array",
            "description": "A list of items that produced the error",
            "items": {
              "type": "object"
            }
          },
          "message": {
            "type": "string",
            "description": "Specific details about this error"
          },
          "path": {
            "type": "string",
            "description": "Internal code reference to the source of the error"
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "Server-generated message, if any"
    },
    "page": {
      "type": "integer",
      "description": "The current page of results"
    },
    "per_page": {
      "type": "integer",
      "description": "The number of results per page"
    },
    "total_count": {
      "type": "integer",
      "description": "The total number of results across all pages"
    }
  }
}