Library Service

Search for Libraries and Library Elements

Changed on
post/api/v1/search

Request

  • Base URL: https://cc-libraries.adobe.io
  • URL: https://cc-libraries.adobe.io/api/v1/search
  • Auth: none declared. Required headers: authorization, x-api-key

Headers

authorizationstring required

An access token issued by Adobe IMS. In the header, the access token must be preceded by Bearer .

x-api-keystring required

The API key assigned to your API client account when you signed up.

x-request-idstring

A unique request identifier that you define. Used by Adobe Support to trace the request in logs. This header is automatically generated by the server and returned in the response if you do not set it explicitly.

Request body

asset_typestring[]

library and/or element. Leaving this out of the request will get both by default, though element-only parameters like library_id or archived will isolate the result to elements.

library_idstring

Library ID (URN) to constrain an elements search to a single library (like "urn:aaid:sc:us:2f3268e9-039d-460f-8b07-8854f7677645"). Invalid if submitted with "asset_type": ["library"].

groupstring

Isolate element results to a single group. Invalid if submitted with "asset_type": ["library"].

namestring

A name string to identify by library/asset name. Requires an exact match.

query_stringstring

A general query string to search for libraries/assets. Includes partial matches.

created_datestring[]

Start & end dates in epoch time (ms since epoch).

modified_datestring[]

Start & end dates in epoch time (ms since epoch).

typestring[]

One or more types for elements, invalid if submitted with "asset_type": ["library"].

archivedboolean

Search specifically for archived elements (boolean true/false to isolate results to archived or non-archived). Invalid if submitted with "asset_type": ["library"].

orderBystring

defaults to -modified_date, also accepts name. Use a minus sign prefix to note descending.

startstring

String value. For libraries lists, the requirement to integrate bookmarked responses requires us to use the field in a clever fashion beyond a simple positive integer.

limitinteger

Positive integer, defines the number of results to return for a paged response. Defaults to 10. Max limit for library searches is 10, max limit for element searches is 100.

ownerstring

private (default), incoming, outgoing, public, or all. all does not include public until bookmarks are integrated into the USS search results.

selectorstring

Customize response for larger/smaller data sets. (default [base response], rendition_grid, collaboration, details, full).

has_stock_contentboolean

Search for libraries that have stock content, or elements within a library that have stock content (boolean true/false to isolate results to stock content or all content).

stock_content_idstring

Search for elements with a specific Stock Content ID. Invalid if submitted with "asset_type": ["library"] or "has_stock_content": false.

spark_brand_urnstring

Search for elements with a specific Spark tracking data brand_urn.

spark_creator_idstring

Search for elements with a specific Spark tracking data creator_id.

spark_content_summarystring

Search for elements with a partial match within the Spark tracking data content_summary.

source_refstring

Search for elements with a specific sourceRef.

Response

OK

total_itemsinteger

Changes