List a component's references

GET

/content/management/v1/components/{id}/usages

const url = 'https://api.ebitex.io/content/management/v1/components/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/usages';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ebitex.io/content/management/v1/components/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/usages \
  --header 'Authorization: Bearer <token>'

Lists every component and page whose content references this component, with the referencing field’s path. A page entry carries nodeId and its nodePath; a component entry carries componentId. These are the references that block a delete.

The list is not filtered by branch access, so it stays complete even when a referencing component sits in a branch the key’s role cannot view. Only ids, names and field paths are returned, never the referencing content.

Key: a management key with content.management.read.

Authorizations

apiKey

Parameters

Path Parameters

required

string format: uuid

Responses

200

[ { "componentId": "…", "nodeId": null, "name": "Home hero", "fieldPath": "hero", "nodePath": null } ]

401

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired.

402

payment_required: the organization’s subscription needs attention.

403

scope_denied: the key lacks this route’s scope. tier_required: the Content Management API needs the Pro plan or above. ip_denied: the caller’s address is outside the key’s allowed ranges. app_not_available: Content is not enabled for the organization.

404

No component has this id, or it is in a branch the key’s role cannot view.

429

Rate limit or quota exceeded; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.