Get a contract

GET

/content/management/v1/contracts/{id}

const url = 'https://api.ebitex.io/content/management/v1/contracts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/contracts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Returns one contract with its own fields in order, its latestVersion (versionNumber, isBreakingFromPrevious and the compiledSchema a component document is validated against), and the rowVersion to send back when you update it.

fields lists only the fields this contract declares itself; inherited fields are part of latestVersion.compiledSchema. titleFieldPath is this contract’s own declaration, while effectiveTitleFieldPath and titleFieldDeclaredByContractId report the one that applies after inheritance. referenceTree, effectiveReferenceTree and referenceTreeDeclaredByContractId work the same way for the tree setting, and externalLinks, effectiveExternalLinks and externalLinksDeclaredByContractId for the links.

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

Authorizations

apiKey

Parameters

Path Parameters

required

string format: uuid

Responses

200

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.

404

No contract with this id exists in the key’s environment.

429

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