Skip to content

Get a published component

GET
/content/delivery/v1/components/{provider}/{key}
curl --request GET \
--url https://api.ebitex.io/content/delivery/v1/components/example/example \
--header 'Authorization: Bearer <token>'

Fetches one published component. provider is core, and key is the component’s id or its external id, so a site can name a standalone component such as its header by the id it was authored under. The response always reports the id as key.

include is repeatable: paths adds the component’s own published addresses, and referencePaths adds addresses to every reference inside its content. resolve, locale, raw and ctx work as on /path. The external id is the one the component was published under, until it is republished.

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

provider
required
string
key
required
string
site
string format: uuid
locale
string
resolve
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
raw
boolean
ctx
string
include
Array<string>

OK

validation_failed: an unsupported include value. invalid_context: ctx is not a valid context bag.

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

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.

not_published: no published component has this id or external id.

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