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 every category group in the key’s environment, 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).

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

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

Authorizations

apiKey

Responses

200

An array of { id, externalId, name, metadataContractId, sourceRegistrationId, metadataFields, rowVersion }. 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.