Tableview

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents a single tableview created with the GUI.

URI
/api/v9/tableviews/ID

Get a tableview

Return information about a tableview, identified by the tableview’s ID. Use GET /api/v9/tableviews to list the available tableviews and their IDs.

Currently it is not possible to set up new tableviews with the API. Use the GUI (or “admin” interface) to create and configure a suitable tableview. The ACL settings for the tableview are irrelevant — all tableviews are visible via the API, no matter who created them.

Syntax
GET /api/v9/tableviews/123
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request
curl
curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/tableviews/123"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The tableview data was successfully returned
`404 Not Found`	The tableview was not found

Example response

Response
{
  "id": 1,
  "created": "2025-01-27T11:13:33+00:00",
  "modified": "2025-07-07T11:03:41+00:00",
  "title": "Applicants by categories",
  "tabledata": "/api/v9/tableviews/1/tabledata"
}

Tableviews

Tabledata