Admin REST API — Endpoints
The Admin API lets you manage projects and their contents. All requests require the Authorization: Bearer <API_KEY> header.
Base URL
Projects
| Method | Path | Description |
|---|---|---|
GET | /projects | List projects for the authenticated account. |
POST | /projects | Create a project. |
GET | /projects/<project_id> | Get a single project. |
PATCH | /projects/<project_id> | Update a project (partial). |
DELETE | /projects/<project_id> | Delete a project. |
Artboards
| Method | Path | Description |
|---|---|---|
GET | /projects/<project_id>/artboards | List artboards in a project. |
POST | /projects/<project_id>/artboards | Create an artboard. |
GET | /projects/<project_id>/artboards/<artboard_id> | Get a single artboard. |
PATCH | /projects/<project_id>/artboards/<artboard_id> | Update an artboard. |
DELETE | /projects/<project_id>/artboards/<artboard_id> | Delete an artboard. |
Objects
| Method | Path | Description |
|---|---|---|
GET | /projects/<project_id>/artboards/<artboard_id>/objects | List objects on an artboard. |
POST | /projects/<project_id>/artboards/<artboard_id>/objects | Create an object. |
GET | /projects/<project_id>/artboards/<artboard_id>/objects/<object_id> | Get a single object. |
PATCH | /projects/<project_id>/artboards/<artboard_id>/objects/<object_id> | Update an object. |
DELETE | /projects/<project_id>/artboards/<artboard_id>/objects/<object_id> | Delete an object. |
Popups
| Method | Path | Description |
|---|---|---|
GET | /projects/<project_id>/popups | List popups in a project. |
POST | /projects/<project_id>/popups | Create a popup. |
GET | /projects/<project_id>/popups/<popup_id> | Get a single popup. |
PATCH | /projects/<project_id>/popups/<popup_id> | Update a popup. |
DELETE | /projects/<project_id>/popups/<popup_id> | Delete a popup. |
Data Sources
| Method | Path | Description |
|---|---|---|
GET | /projects/<project_id>/data-sources | List data sources. |
POST | /projects/<project_id>/data-sources | Create a data source. |
GET | /projects/<project_id>/data-sources/<data_source_id> | Get a single data source. |
PATCH | /projects/<project_id>/data-sources/<data_source_id> | Update a data source. |
DELETE | /projects/<project_id>/data-sources/<data_source_id> | Delete a data source. |
Variables
| Method | Path | Description |
|---|---|---|
GET | /projects/<project_id>/variables | List variables. |
POST | /projects/<project_id>/variables | Create a variable. |
GET | /projects/<project_id>/variables/<variable_id> | Get a single variable. |
PATCH | /projects/<project_id>/variables/<variable_id> | Update a variable. |
DELETE | /projects/<project_id>/variables/<variable_id> | Delete a variable. |
Actions
| Method | Path | Description |
|---|---|---|
GET | /projects/<project_id>/actions | List actions. |
POST | /projects/<project_id>/actions | Create an action. |
GET | /projects/<project_id>/actions/<action_id> | Get a single action. |
PATCH | /projects/<project_id>/actions/<action_id> | Update an action. |
DELETE | /projects/<project_id>/actions/<action_id> | Delete an action. |
Quick Examples
Note
Errors:
401 for missing/invalid token or unauthorized; 404 when the resource is not found.