Skip to content

Get a component

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

Returns one component’s current authoring state: its document, contract, folder, and the contract version it is pinned to. It is the working copy, not what is published; publishStatus is draft, published, modified or unpublished.

When a newer contract version exists, validatesAgainstLatest says whether the document would pass it, and latestValidationErrors lists what would fail. Keep rowVersion to send back with an update.

Branch access rules apply to the key as they do to its role: a component in a folder the role cannot view reads as not found. effectiveActions says what the role may do to this component.

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

id
required
string format: uuid

OK

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

payment_required: the organization’s subscription needs attention.

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.

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

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