Library Service

Retrieve the elements within a library

Changed on
get/api/v1/libraries/{libraryId}/elements

Request

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

Path parameters

libraryIdstring required

The ID of the requested library. For private libraries, the library_urn should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) For public libraries, the public library id should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)

Query parameters

orderBystring

Sorting option for the response list. Reverse sort is enabled with a - character ahead of the sorting vector. (ex: -modified_date) Multi-vector sort is enabled by including multiple vectors separated by commas. (ex: name,-modified_date) Sorting is not available for public libraries.

Possible Values

  • name: Sort by the name.
  • modified_date: Sort by the last modified date.
startstring

The first result to include for a paged response, 0-based. This parameter is required if a limit is specified. Paging is not available for public libraries.

limitstring

The number of results to return for a paged response. Paging is not available for public libraries.

Possible Values

  • Min: 1.
  • Max: 100.
typestring

Limits results to those identified with the provided element mimetype.

groupstring

Limits results to those assigned to the provided group_id (can be either group_id or classifier#group_id). Parameters without a classifier will populate as $default#group_id. To specify ungrouped elements, use $none$

selectorstring

Customize which data sets to include in the response. All applications using this API will need the same sets of data, but different applications will not require different depths of details. Callers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs.

Possible Values

  • default: Base data, use this to build out custom response.
  • details: All available data for in-depth display.
  • representations: Flattened list of assets associated with the library element.

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.

if-none-matchstring

The etag value, returns content only if the asset's etag is EXACTLY the same.

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.

Response

OK

total_countinteger

Total results for query

Changes