assets

List editable resources that use an asset

Returns editable resources that reference this asset. Each entry indicates whether the reference appears in the resource's draft, published version, or both. Results reflect the latest saved versions, so they exclude unsaved editor changes and older published versions.

Only resources you have permission to read are included. Email-template references require email_management:read in addition to assets:read. Hidden resources do not affect the truncated flag.

Removing an asset does not break existing references because its original URL keeps serving. Use this list to find content that should reference a replacement asset.

get/v1/assets/{asset_id}/references

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/assets/{asset_id}/references
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

asset_idstring required
Example:ast_01krdgeqcxet5s7t44vh8rt9mg

ID of the asset.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The resources that reference the asset.

truncatedboolean required

True when more resources use this asset than one response can carry, so the list is a partial answer. Replace the asset's usages you can see, then list again to find the rest.

Example response

{
  "data": [
    {
      "resource_id": "emt_01j9zyq8k7f0ra2m6c4x5w8pv3"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.