- General
- Endpoints
Create New BoardView
POST
/board/{board_id}/view
Request
Path Params
board_id
string
required
Header Params
x-api-key
string
required
Default:
{{api_key}}
x-api-env
string
required
Default:
{{api_env}}
Body Params application/json
created_for_user_id
string <uuid>
write-onlyoptional
type
enum<string>
required
Allowed values:
agendaanalyticsapp_listapp_list_per_daybacklogcalendarcapacitykanbanlisttimeline
name
string
required
position
integer
optional
visibility
string
optional
protected
boolean
optional
forced
boolean
optional
share_options
object
optional
filters
boolean
required
preferences
boolean
required
columns
boolean
required
shared_users
array[string]
optional
forced_users
array[string]
optional
settings
object
optional
Example
{
"created_for_user_id": "cba53b35-82ca-5b6a-ed4d-f1ac8656bd08",
"id": "-1GZDZS9yjcFFw5tZ7zwK",
"type": "list",
"name": "Colleen Bashirian",
"position": 4,
"visibility": "private",
"protected": false,
"forced": false,
"share_options": {
"filters": true,
"preferences": true,
"columns": true
},
"shared_users": [],
"forced_users": [],
"settings": {},
"created_at": "2025-06-29T13:41:27.369Z"
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vplan.com/v1/board//view' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw '{
"created_for_user_id": "cba53b35-82ca-5b6a-ed4d-f1ac8656bd08",
"id": "-1GZDZS9yjcFFw5tZ7zwK",
"type": "list",
"name": "Colleen Bashirian",
"position": 4,
"visibility": "private",
"protected": false,
"forced": false,
"share_options": {
"filters": true,
"preferences": true,
"columns": true
},
"shared_users": [],
"forced_users": [],
"settings": {},
"created_at": "2025-06-29T13:41:27.369Z"
}'
Responses
🟢201Created
application/json
Body
id
string <uuid>
optional
type
enum<string>
optional
Allowed values:
agendaanalyticsapp_listapp_list_per_daybacklogcalendarcapacitykanbanlisttimeline
name
string
optional
position
integer
optional
visibility
string
optional
protected
boolean
optional
forced
boolean
optional
share_options
object
optional
filters
boolean
required
preferences
boolean
required
columns
boolean
required
shared_users
array[string]
optional
forced_users
array[string]
optional
settings
object
optional
created_at
string <date-time>
required
updated_at
string <date-time>
optional
Example
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "agenda",
"name": "string",
"position": 0,
"visibility": "string",
"protected": true,
"forced": true,
"share_options": {
"filters": true,
"preferences": true,
"columns": true
},
"shared_users": [
"string"
],
"forced_users": [
"string"
],
"settings": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
🟠404Not Found
🟠401Not Logged In
Modified at 2025-06-30 07:17:14