List the environment's items

GET

/content/management/v1/items

const url = 'https://api.ebitex.io/content/management/v1/items';
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/items \
  --header 'Authorization: Bearer <token>'

A flat inventory of the key’s environment: every contract, template, component, adapter, stream, audience, category group, category, folder and page node, by id and name. Use it to check whether something exists without exporting it.

kind narrows the listing to one of contract, template, component, adapter, stream, audience, categoryGroup, category, folder or node.
limit is the page size, 1 to 200 (default 200). Pass nextCursor back as cursor, exactly as received, with the same kind; null means there are no more.

Each item carries a naturalKey, the stable, environment-independent name an import plan reports and baseTokens is keyed by. Categories, folders and nodes have no externalId, so their naturalKey is a path. parentId is a component’s folder, a folder’s or node’s parent, and a category’s parent category or, at the top level, its group.

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

Authorizations

apiKey

Parameters

Query Parameters

kind

string

limit

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

cursor

string

Responses

200

{ "items": [ { "kind", "id", "externalId", "naturalKey", "name", "parentId" } ], "nextCursor": "…" | null }

400

validation_failed: an unknown kind; the response lists the valid ones. invalid_cursor: the cursor is malformed or belongs to a different listing; restart from the first page.

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.

429

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