academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Database-table-columns [Beta] → List columns of a database table

AI-generated

Summary

Retrieve a list of columns for a specified database table from the academyFIVE API.

Inputs

  • databaseTable (required) — The name of the database table or data source to retrieve columns for. Example: student_profile.
  • Additional Fields — Optional pagination parameters to control the page number (starting at 1) and the number of results per page (default 50).

Output shape

a JSON array where each item represents a column detail of the specified database table

Supports pagination through the optional 'page[number]' and 'page[size]' query parameters to navigate through results if the number of columns exceeds one page.

Examples

Example 1: List columns of the 'student_profile' database table without pagination parameters, receiving the first page with up to 50 columns.

Set 'databaseTable' to 'student_profile'. Leave additional fields empty or default.

Example 2: Fetch the second page of columns with 25 columns per page for a large database table.

Set 'databaseTable' appropriately. Add 'page[number]' as 2 and 'page[size]' as 25 under Additional Fields.

Links

Discussion