Skip to main content
GET
/
api
/
knowledge-clause-features
List Knowledge Clause Features
curl --request GET \
  --url https://platform.kodexa.ai/api/knowledge-clause-features \
  --header 'x-api-key: <api-key>'
{
  "content": [
    {
      "changeSequence": 123,
      "clauseId": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "feature": {
        "active": true,
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "extendedProperties": {},
        "featureType": {
          "active": true,
          "changeSequence": 123,
          "color": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "extendedOptions": {},
          "icon": "<string>",
          "id": "<string>",
          "labelJsonPath": "<string>",
          "name": "<string>",
          "options": {},
          "organization": {
            "authGroupLink": {
              "authGroup": "<string>"
            },
            "changeSequence": 123,
            "createdOn": "2023-11-07T05:31:56Z",
            "defaultToPrivateTemplates": true,
            "description": "<string>",
            "enterpriseOrganization": true,
            "features": {},
            "hasImage": true,
            "id": "<string>",
            "memory": {
              "orderedDashboards": [
                "<string>"
              ]
            },
            "name": "<string>",
            "organizationStatus": "<string>",
            "properties": {},
            "publicAccess": true,
            "searchText": "<string>",
            "slug": "<string>",
            "stripeCustomerId": "<string>",
            "supportAccess": true,
            "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "uuid": "<string>"
          },
          "organizationId": "<string>",
          "slug": "<string>",
          "updatedOn": "2023-11-07T05:31:56Z",
          "useJSONata": true,
          "uuid": "<string>"
        },
        "featureTypeId": "<string>",
        "id": "<string>",
        "organization": {
          "authGroupLink": {
            "authGroup": "<string>"
          },
          "changeSequence": 123,
          "createdOn": "2023-11-07T05:31:56Z",
          "defaultToPrivateTemplates": true,
          "description": "<string>",
          "enterpriseOrganization": true,
          "features": {},
          "hasImage": true,
          "id": "<string>",
          "memory": {
            "orderedDashboards": [
              "<string>"
            ]
          },
          "name": "<string>",
          "organizationStatus": "<string>",
          "properties": {},
          "publicAccess": true,
          "searchText": "<string>",
          "slug": "<string>",
          "stripeCustomerId": "<string>",
          "supportAccess": true,
          "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "<string>"
        },
        "organizationId": "<string>",
        "properties": {},
        "slug": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "featureId": "<string>",
      "id": "<string>",
      "positive": true,
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    }
  ],
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Query Parameters

​
page
integer<int32>

Page number (1-indexed). Defaults to 1.

​
pageSize
integer<int32>

Number of items per page (1-1000). Defaults to 20, maximum 1000.

​
sort
string

Sort expression as field,direction. Direction is asc or desc. Multiple sort fields can be specified by repeating the parameter.

​
filter
string

RSQL/FIQL filter expression. Supported operators: == (equals), != (not equals), =like= (contains), =in= (in list), > / >= / < / <= (comparison), =isnull=true (is null), =isnull=false (is not null). Combine with ; (AND) or , (OR). Example: name=='Acme Corp';status==active

​
query
string

Full-text search query matching against the entity's searchable fields.

Response

Page of KnowledgeClauseFeature

Paginated response containing KnowledgeClauseFeature items.

​
content
object[]

Array of KnowledgeClauseFeature items on this page.

​
first
boolean

Whether this is the first page.

​
last
boolean

Whether this is the last page.

​
number
integer<int32>

Current page number (0-indexed).

​
numberOfElements
integer<int32>

Number of items on the current page.

​
pageable
object

Pagination metadata.

​
size
integer<int32>

Page size (number of items per page).

​
sort
object

Sort metadata.

​
totalElements
integer<int64>

Total number of items across all pages.

​
totalPages
integer<int32>

Total number of pages.