Skip to main content
GET
/
api
/
data-forms
List Data Forms
curl --request GET \
  --url https://platform.kodexa.ai/api/data-forms \
  --header 'x-api-key: <api-key>'
{
  "content": [
    {
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "deprecated": true,
      "extensionPackRef": "<string>",
      "id": "<string>",
      "metadata": {
        "actions": [
          {
            "name": "<string>",
            "properties": {},
            "type": "<string>"
          }
        ],
        "cards": [
          {
            "children": "<array>",
            "id": "<string>",
            "properties": {},
            "type": "<string>"
          }
        ],
        "views": [
          {
            "name": "<string>",
            "properties": {}
          }
        ]
      },
      "name": "<string>",
      "publicAccess": true,
      "slug": "<string>",
      "template": true,
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>",
      "version": "<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 DataFormMetadata

Paginated response containing DataFormMetadata items.

content
object[]

Array of DataFormMetadata 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.