Skip to main content
GET
/
api
/
taxonomies
/
{organizationSlug}
cURL
curl --request GET \
  --url http://localhost/api/taxonomies/{organizationSlug}
{
  "totalPages": 123,
  "totalElements": 123,
  "size": 123,
  "content": [
    {
      "ref": "<string>",
      "template": true,
      "orgSlug": "<string>",
      "slug": "<string>",
      "type": "<string>",
      "name": "<string>",
      "description": "<string>",
      "version": "<string>",
      "get_id": "<string>",
      "publicAccess": true,
      "imageUrl": "<string>",
      "icon": "<string>",
      "overviewMarkdown": "<string>",
      "provider": "<string>",
      "providerUrl": "<string>",
      "providerImageUrl": "<string>",
      "deleteProtection": true,
      "checksum": "<string>",
      "deprecated": true,
      "extensionPackRef": "<string>",
      "taxonomyType": "CONTENT",
      "enabled": true,
      "externalDataTaxonomyRefs": [
        "<string>"
      ],
      "taxons": [
        {
          "id": "<string>",
          "label": "<string>",
          "order": 123,
          "generateName": true,
          "group": true,
          "name": "<string>",
          "selectWeight": 123,
          "externalName": "<string>",
          "valuePath": "VALUE_OR_ALL_CONTENT",
          "metadataValue": "FILENAME",
          "dataPath": "<string>",
          "expression": "<string>",
          "enableFallbackExpression": true,
          "fallbackExpression": "<string>",
          "enableSerializationExpression": true,
          "serializationExpression": "<string>",
          "nullable": true,
          "nullValue": "<string>",
          "denormalizeToChildren": true,
          "notUserLabelled": true,
          "description": "<string>",
          "overviewMarkdown": "<string>",
          "semanticDefinition": "<string>",
          "synonyms": [
            "<string>"
          ],
          "lexicalRelations": [
            {
              "type": "SYNONYM",
              "value": "<string>",
              "weight": 123
            }
          ],
          "additionContexts": [
            {
              "type": "RECORD_DEFINITION",
              "context": "<string>",
              "weight": 123,
              "negative": true
            }
          ],
          "guideProperties": {
            "guidanceKey": true,
            "guidanceKeyExpression": "<string>",
            "useGuidanceForClassification": true,
            "ifPresentRequired": true
          },
          "enabled": true,
          "color": "<string>",
          "children": [
            {}
          ],
          "options": [
            {
              "groupOptions": [
                {}
              ],
              "properties": {},
              "tabName": "<string>",
              "name": "<string>",
              "aliases": [
                "<string>"
              ],
              "label": "<string>",
              "falseLabel": "<string>",
              "hint": "<string>",
              "required": true,
              "type": "<string>",
              "subType": "<string>",
              "listType": "<string>",
              "displayProperties": {},
              "listLabel": "<string>",
              "listDescription": "<string>",
              "featureFlag": "<string>",
              "default": {},
              "description": "<string>",
              "supportArticle": "<string>",
              "overviewMarkdown": "<string>",
              "showIf": "<string>",
              "developerOnly": true,
              "showOnPopup": true,
              "possibleValues": [
                {
                  "label": "<string>",
                  "value": {},
                  "description": "<string>"
                }
              ]
            }
          ],
          "nodeTypes": [
            "<string>"
          ],
          "taxonType": "STRING",
          "selectionOptions": [
            {
              "label": "<string>",
              "id": "<string>",
              "description": "<string>",
              "isConditional": true,
              "conditionalFormula": "<string>",
              "lexicalRelations": [
                {
                  "type": "SYNONYM",
                  "value": "<string>",
                  "weight": 123
                }
              ]
            }
          ],
          "typeFeatures": {},
          "properties": {},
          "conditionalFormats": [
            {
              "type": "<string>",
              "condition": "<string>",
              "properties": {}
            }
          ],
          "validationRules": [
            {
              "name": "<string>",
              "disabled": true,
              "description": "<string>",
              "conditional": true,
              "conditionalFormula": "<string>",
              "ruleFormula": "<string>",
              "messageFormula": "<string>",
              "detailFormula": "<string>",
              "exceptionId": "<string>",
              "supportArticleId": "<string>",
              "overridable": true
            }
          ],
          "cardinality": "ONCE_PER_DOCUMENT",
          "path": "<string>",
          "multiValue": true,
          "userEditable": true,
          "usePostExpression": true,
          "postExpression": "<string>"
        }
      ],
      "totalTaxons": 123
    }
  ],
  "number": 123,
  "sort": [
    {
      "direction": "<string>",
      "nullHandling": "<string>",
      "ascending": true,
      "property": "<string>",
      "ignoreCase": true
    }
  ],
  "first": true,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "sort": [
      {
        "direction": "<string>",
        "nullHandling": "<string>",
        "ascending": true,
        "property": "<string>",
        "ignoreCase": true
      }
    ],
    "paged": true,
    "unpaged": true,
    "pageNumber": 123,
    "pageSize": 123
  },
  "last": true,
  "empty": true
}

Path Parameters

organizationSlug
string
required

Query Parameters

page
integer
default:0

Zero-based page index (0..N)

pageSize
integer
default:10

The size of the page to be returned

sort
string

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

filter
string

A filter that will be applied

query
string

A simple text query that will be applied

Response

OK

totalPages
integer
totalElements
integer
size
integer
content
object[]
number
integer
sort
object[]
first
boolean
numberOfElements
integer
pageable
object
last
boolean
empty
boolean
I