Library Service

Retrieve libraries for a user

Changed on
get/api/v1/libraries

Request

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

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 libraries to return for a paged response. Paging is not available for public libraries.

Possible Values

  • Min: 1.
  • Max: 10.
ownerstring

Customize which libraries to include in the response, based on ownership.

Possible Values

  • private: Libraries owned by the user.
  • incoming: Libraries shared with the user. This may include person-to-person shared libraries as well as libraries accessible via group ownership.
  • public: Libraries the user has followed.
  • all: All of the above except public.
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.
  • collaboration: Add collaboration data to a lesser-scoped selector.
  • groups: Include group data in the response.
  • rendition_grid: Provides a set of links to library element image renditions, which can be combined to create a thumbnail for the library. The main rendition link is the first asset uploaded to the library, while the tiles contain the three most recently updated library elements' rendition links.
toolkitstring

Customize which toolkit libraries to include in the response.

Possible Values- all: Include all toolkit libraries.

  • none: Do not include any toolkit libraries.
  • <toolkit-id>: Include libraries matching a specific toolkit-id, or comma-separated list of toolkit-ids.

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.

Response

OK

total_countinteger

Total results for query

Changes

    • warning

      deleted the header request parameter x-organization-id

    • warning

      deleted the query request parameter workspace