---
title: "Retrieve all assets."
method: GET
path: "/authoring/v1/assets"
tags: ["Authoring assets"]
---

# Retrieve all assets.

`GET /authoring/v1/assets`

Use this endpoint to retrieve all assets from the database.<br />User roles: admin, manager, editor, viewer

## Query parameters

- `limit` integer
- `offset` integer
- `fields` string[]
- `include` string[]

## Response `200`

Successfully lists a paged result view of all the asset in the database.

- object
  - `limit` integer, required — The page size. Set to 50 by default.
  - `offset` integer, required — The number of items to skip from the beginning of the list.
  - `href` string, required — A link to the current page.
  - `next` string — A link to the next page. Only shown if a next page exists.
  - `previous` string — A link to the previous page. Only shown if a previous page exists.
  - `items` object[], required
    - `id` string — The id of the asset.
    - `rev` string — The revision of the asset.
    - `name` string — Name of the asset.
    - `classification` 'asset' — The classification of the asset is always "asset".
    - `assetType` 'image' | 'video' | 'file' — The type of asset. Determined by the media type of the resource.
    - `description` string — Description of the asset.
    - `creatorId` string — The ID of the user that created the asset.
    - `created` string, date-time — The date and time the asset was created.
    - `creator` string — The name of the user who originally created the asset.
    - `lastModifierId` string — The ID of the user that last modified the asset.
    - `lastModified` string, date-time — The date and time the asset was last modified.
    - `lastModifier` string — The name of the user who last modified the item.
    - `systemModified` string, date-time — The date and time the asset was last modified by the system.
    - `fileName` string — The file name of the asset's resource.
    - `fileSize` integer — The size of the asset's resource in bytes.
    - `mediaType` string — Media type of the asset's resource.
    - `keywords` string[] — When AI analysis is complete, the document type assets will be automatically updated with keywords generated by the analysis. Keywords are updated only for PDF, doc, html, and plain text files.
    - `tags` object — The "values" array defines the user selected tags. The other two properties "declined" and "suggested" relate directly to the interaction with the cognitive analysis feature.
      - `values` string[], required — Tags can be set here. Tags suggested by cognitive analysis should be copied into this array if you wish to accept them.
      - `declined` string[], required — This editable field is given for the store values from cogntivie analysis that the user has dismissed/rejected. This essentially. It is up to the API client to update this field. This field is not indexed for search.
      - `suggested` string[] — Suggested field is a read only field that is populated if cognitive analysis is done on this asset. Once reviewed the suggestions can be cleared with a query parameter see update endpoint. The tags come in the form of "prefix:tag" e.g. "classification:sky" This field is not indexed for search.
      - `analysis` 'complete' | 'failed' | 'none' | 'pending' — This field indicates the progress of AI analysis.
      - `analysisStarted` integer — This field exists when analysis is launched but not complete. The value is the epoch time of when the analysis began.
    - `resource` string, required — The ID of the uploaded resource this asset contains.
    - `digest` string — The Base64 encoded MD5 digest of the resouce the asset contains.
    - `path` string — The path to this asset, must begin with a leading slash. A unique constraint is placed on this path so that no other asset can have the same path. When updating path a collision results in error. Paths begining with "/dxdam/" are managed assets.
    - `categoryIds` string[] — The IDs of the categories that define how this asset is categorized.
    - `profiles` string[] — The IDs of image profiles to add to use on this asset.
    - `profileRenditions` object[] — The transform instructions for each of the renditions in the "profiles" array. If a rendition for one of those image profiles is not defined, a rendition with the best fit will automatically be generated.
      - `profileId` string — The ID of the image profile this rendition belongs to. This ID must also be specified in the "profiles" array.
      - `profileName` string — The name of the image profile this rendition belongs to. This field will only be included when metadata is provided as a value of the include query parameter.
      - `key` string — The key to this rendition.
      - `label` string — The label to this rendition. This field will only be included when metadata is provided as a value of the include query parameter.
      - `uri` string — The URI to the resource in this rendition's dimensions.
      - `width` number — The width defined for this rendition.
      - `height` number — The height defined for this rendition.
      - `transform` object — The transform instructions to achieve this rendition's dimensions. If not specified, a best fit transformation will automatically be generated.
        - `scale` number — The scale to perform on the original resource. The value must be between 0 (exclusive) and 1 (inclusive).
        - `crop` object — The crop to apply on the resource after any scaling has been done.
          - `x` number — The X coordinate to start the crop from
          - `y` number — The Y coordinate to start the crop from
          - `width` number — The width to crop out
          - `height` number — The height to crop out
    - `renditions` object — The renditions for the asset. Mandatory for an image asset. Does not appear for a video or file asset.
      - `default` object
        - `id` string — The ID of the rendition.
        - `source` string — The link to the rendition binary.
    - `status` 'ready' | 'draft' | 'retired' — The workflow status of the asset.
    - `valid` boolean — Boolean that indicates if an asset can be transitioned from draft to ready. Only available on draft assets.
    - `draftStatus` 'in-review' | 'in-progress' | 'approved' — This property shows the status of the draft and is only valid for draft items. By default, it is in-progress.
    - `links` object
      - `self` object — Relative link to the asset itself.
        - `href` string
      - `media` object — The link to the resource binary.
        - `href` string
      - `thumbnail` object — The link to a thumbnail of the image. Only avaliable for certain assets of type image.
        - `href` string
      - `ready` object — This link will appear for items that can be transitioned to the ready state.
        - `href` string
      - `retire` object — This link will appear for items that can be transitioned to the retired state.
        - `href` string
      - `linkedDoc` object — This link will appear if this item is a draft of an existing item. The link points to the primary item.
        - `href` string
    - `usageRights` object — Usage rights are assigned to assets to help composers understand where and when an asset can be used. For example, an asset might be used only in print, only for an advertising campaign, and only for a limited time.
      - `categories` object[]
        - `id` string — The ID of the usage rights category associated to the asset.
        - `path` string — Name path of the usage rights category associated to the asset. This field will only be included when metadata is provided as a value of the include query parameter.
      - `expiration` string, date-time — The user will have up until this ISO 8601 specified date-time value before they no longer have permission to use the asset.
    - `review` object — Information and/or state about the review.
      - `id` string, required — ID of the review.
      - `name` string, required — Name of the review.
      - `started` string, date-time, required — The ISO 8601 date-time that the review started.
      - `ends` string, date-time — The ISO 8601 date-time that the review is to be completed by.
      - `ended` string, date-time — The ISO 8601 date-time that the review actually finished on.
      - `ownerId` string, required
    - `metadata` object — Information extracted from an image asset's metadata.
      - `width` integer — Width of the image.
      - `height` integer — Height of the image.
      - `camera` object — Digital camera information extracted from the image asset's metadata.
        - `make` string — The manufacturer of the camera used to take the photo.
        - `model` string — The model of the camera used to take the photo.
        - `focalLength` integer — The focal length of the lens used to take the photo.
        - `shutterSpeed` string — The shutter speed setting of the camera used to take the photo.
        - `iso` integer — The ISO setting of the camera used to take the photo.
        - `aperture` integer — The aperture of the lens used to take the photo.
      - `coverage` string — Scope of the image. Possible uses include a location or a time period.
      - `creator` string — Creator of the image.
      - `Date` string — Creation date and time of the image.
      - `description` string — Description of the image.
      - `publisher` string — Publisher of the image.
      - `rights` string — Rights information of the image.
      - `source` string — Source information of the image.
      - `subject` string[] — Topic(s) of the image.
      - `title` string — Title of the image
      - `headline` string — Headline of the image
    - `cognitive` object — Information extracted from the asset produced by cognitive analysis
      - `classifications` string[] — The classification suggested by cognitive analysis
      - `faces` object[] — Person's details. Image asset only
        - `name` string — Name of person
        - `gender` string — Gender of person
        - `age` object — Age range of person
          - `minimum` integer — Minimum age of person
          - `maximum` integer — Maximum age of person
      - `colors` object — Prominent colors from an image. Image asset only
        - `vibrant` string
        - `muted` string
        - `darkVibrant` string
        - `darkMuted` string
        - `lightVibrant` string
        - `lightMuted` string
      - `concepts` string[] — Perform concept extraction operations from documents
      - `entities` string — Perform entity extraction operations from documents
      - `keywords` string[] — Perform keyword extraction operations from documents
      - `status` 'complete' | 'failed' | 'none' | 'pending' — This field indicates the progress of AI analysis
    - `isManaged` boolean — This field indicates whether the asset is managed or not. An asset is considered managed only if its asset path starts with "dxdam".
    - `altText` string — A text description of the asset, used when the asset itself is not available or not displayed.
    - `caption` string — A caption of the asset image.
    - `linkedDocId` string — Provided on drafts of existing items. This is the ID of the primary item.
    - `categories` string[]
    - `isSystem` boolean — Indicates whether this item is a 'system item' or not. 'System item' means that this is an item managed internally by Acoustic.
    - `libraryId` string — If this property is set it points to library id that the item is assigned to.

## Other responses

- `429` — Too Many Requests, the server has reached a limit, the request must be sent again at a later time.
- `503` — Connection failed to data store.
- `default` — Unexpected error.

---

[API](https://skmtc.net/goacoustic/apis/acoustic-content-api.md) · [All operations](https://skmtc.net/goacoustic/apis/acoustic-content-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/goacoustic/acoustic-content-api/revisions/677305266d89/schema)