Tableviews
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a list of all tableviews created in the DreamApply portal.
URI
/api/v10/tableviewsView all API requests
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v10/tableviews | C | GET HEAD | List all tableviews created in DreamApply |
/api/v10/tableviews/ID | R | GET HEAD | Get a tableview created in DreamApply |
/api/v10/tableviews/ID/tabledata | R | GET HEAD | Get the CSV data from a tableview |
GET List tableviews
List all tableviews that have been created in the DreamApply portal.
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.
When setting up tableviews in the DreamApply portal, give them descriptive names so that you can easily recognise them.
Syntax
GET /api/v10/tableviews
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"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 |
X-Count | 15 | The number of available tableviews |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of tableviews was successfully returned |
Example response
Response
{
"1": {
"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"
},
"2": {
"id": 2,
"created": "2025-02-17T07:48:28+00:00",
"modified": "2025-05-30T10:44:42+00:00",
"title": "Re-opened applications",
"tabledata": "/api/v10/tableviews/1/tabledata"
},
"3": {
"id": 3,
"created": "2025-05-29T12:57:45+00:00",
"modified": "2025-11-03T09:40:12+00:00",
"title": "Accepted offers (Undecided)",
"tabledata": "/api/v10/tableviews/3/tabledata"
}
}