List components

GET

/content/management/v1/components

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

Lists the components in the key’s authoring environment, drafts included, as summaries without their documents. Components in branches the key’s role cannot view are left out, and totalCount counts only the ones it can see.

folderId lists one folder’s direct contents; rootOnly=true lists only components filed at the root.
contractId matches one contract exactly; adheresToContractId also matches every contract that inherits from it.
categoryId matches components tagged with, or holding a category field value of, that category or any of its sub-categories.
search is a case-insensitive substring match on name and external id; externalId is an exact match.
sort is name (the default) or updated (most recently changed first).

Paging is by number: page starts at 1, and pageSize defaults to 20 with a maximum of 100. Each summary carries the pinned and latest contract version numbers, whether it satisfies its folder’s allowed contracts, and effectiveActions: what the key’s role may do to it.

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

Authorizations

apiKey

Parameters

Query Parameters

folderId

string format: uuid

rootOnly

boolean

contractId

string format: uuid

adheresToContractId

string format: uuid

categoryId

string format: uuid

search

string

externalId

string

sort

string

page

integer | string format: int32

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

pageSize

integer | string format: int32

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

Responses

200

{ "items": [ … ], "totalCount": 42, "page": 1, "pageSize": 20 }

400

invalid_sort: sort is neither name nor updated.

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.