List published components

GET

/content/delivery/v1/components

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

Lists published components of a contract, by its id or external id, including every contract that inherits from it. Results are paged: pass nextCursor back as cursor, exactly as received; null means there are no more.

category filters by category path or id, and is repeatable (every value must match). Matching includes sub-categories.
include=content returns each item’s resolved content, shaped like getComponent. resolve, raw and ctx are only accepted with it.
include=paths adds each item’s published addresses, and include=referencePaths adds addresses to the references inside its content.
orderBy orders by one top-level field and direction by asc or desc. Date fields order chronologically; items without the field come last either way.

Key: a delivery key (content.delivery.read).

Authorizations

apiKey

Parameters

Query Parameters

contract

string

site

string format: uuid

limit

integer | string format: int32

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

cursor

string

category

Array<string>

include

Array<string>

orderBy

string

direction

string

locale

string

resolve

integer | string format: int32

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

raw

boolean

ctx

string

Responses

200

400

unknown_contract: no contract has this id or external id. unknown_category: no category has this path or id. invalid_cursor: the cursor is malformed or belongs to a different order; restart from the first page. validation_failed: an unsupported parameter, or a read option sent without include=content.

401

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

403

scope_denied: the key lacks this route’s scope. origin_denied or ip_denied: a browser-safe key was used from an origin or address outside its restrictions. app_not_available: Content is not enabled for the organization.

429

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