List contracts

GET

/content/management/v1/contracts

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

Lists the contracts in the key’s environment, ordered by name, as summaries: id, externalId, name, isAbstract, parentContractId and defaultFolderId. A contract synced from an external content provider carries providerSourceKey, and one inherited from another environment carries sourceEnvironmentId; both are read-only here.

Results are paged by number: page starts at 1 and pageSize defaults to 20, capped at 100. category takes a category id and is repeatable; a contract must be tagged with every one given. Sub-categories are not included.

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

Authorizations

apiKey

Parameters

Query Parameters

page

integer | string format: int32

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

pageSize

integer | string format: int32

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

category

Array<string>

Responses

200

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

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.