Tableview

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

Represents a single tableview created in the DreamApply portal.

URI
/api/v10/tableviews/ID

Get a tableview

Return information about a specific tableview. Use GET /api/v10/tableviews to list the available tableviews and retrieve their IDs.

Currently it is not possible to set up new tableviews with the API. Use the DreamApply portal 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/v10/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/v10/tableviews/123"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	The media type of the resource
`Content-Length`	`1234`	The 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/v10/tableviews/1/tabledata"
}