List category groups

GET

/content/management/v1/taxonomy/groups

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

Lists the category groups the key’s environment uses, ordered by external id. A group is one dimension of classification, such as topic or region, and its external id is the first segment of every category path inside it (topic/news/local).

Category groups and categories are the organization’s vocabulary, shared by every app and every environment, and managed in Hub. An environment sees only the groups that have been added to it, and this surface lists and acts on those. Send scope=available to list the organization’s groups this environment does not use yet instead.

Each group carries metadataFields: the fields every category in the group must supply as metadata in this environment, or an empty list when the group has none here. sourceRegistrationId is set when a content provider supplies the group.

A group the organization has given custom fields in Hub also carries platformMetadataFields, those fields as { key, label, fieldType, settings, isMandatory, isEnumerable, isLocalizable }. They are the organization’s own, the same in every environment and every app, and are separate from metadataFields. The member is left out when the group has none, and this API reads it but does not change it.

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

Authorizations

apiKey

Parameters

Query Parameters

scope

string

Responses

200

An array of { id, externalId, name, metadataContractId, sourceRegistrationId, metadataFields, rowVersion, isBound, categoryCount, usageCount }. isBound says whether the environment uses the group; usageCount is how many things in the environment still keep it there. platformMetadataFields is added only for a group with organization custom fields (see above). Send rowVersion back when renaming the group to detect a concurrent change.

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.