Search catalogs for assets

v1.0.0

This endpoint searches for assets in the account's catalog. If you specify more than one search parameter, the API uses an AND condition. Array parameters can be specified multiple times; in this case, the API uses an AND or an OR condition with those values, depending on the parameter. You can also filter search terms out in the query parameter by prefixing the term with NOT.

Input

{
  "type": "object",
  "properties": {
    "asset_type": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "image",
          "video",
          "audio",
          "elements",
          "editorial-image",
          "editorial-video"
        ]
      }
    },
    "collection_id": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "page": {
      "type": "integer"
    },
    "per_page": {
      "type": "integer"
    },
    "query": {
      "type": "string"
    },
    "sort": {
      "type": "string",
      "enum": [
        "newest",
        "oldest"
      ]
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "List of catalog collection items",
  "required": [
    "data",
    "page",
    "per_page",
    "total_count"
  ],
  "properties": {
    "data": {
      "type": "array",
      "description": "List of catalog collection items",
      "items": {
        "type": "object",
        "description": "Metadata about an item that is part of a collection",
        "required": [
          "id",
          "asset",
          "created_time"
        ],
        "properties": {
          "asset": {
            "type": "object",
            "required": [
              "type"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "image",
                  "video",
                  "audio",
                  "editorial-image",
                  "editorial-video"
                ]
              }
            }
          },
          "collection_ids": {
            "type": "array",
            "description": "The collection IDs that this asset belongs to",
            "items": {
              "type": "string"
            }
          },
          "created_time": {
            "type": "string",
            "format": "date-time"
          },
          "id": {
            "type": "string"
          }
        }
      }
    },
    "page": {
      "type": "number"
    },
    "per_page": {
      "type": "number"
    },
    "total_count": {
      "type": "number"
    }
  }
}