vPlan
  1. Board
vPlan
  • General
    • Structure
    • Synchronize Data
    • Pagination
    • Sorting
    • Filtering
    • Show & Hide
    • Eager Loading
    • Deep Insertion
    • Deprecated
    • External Reference
    • Rate Limits
    • Authentication
      • Authentication
        • Get authorization
        • Token Exchange
      • Me
        • Retrieve information about current authentication
    • Errors
      • Empty values in created object
      • Memory Exhausted
      • Report an issue
      • Service Unavailable
      • Retrieve Api Messages
  • Endpoints
    • Base Data
      • Board
        • Label
        • Status
        • Capacity
          • Capacity Stage
          • Capacity Resource Type Stage
          • Capacity Resource
          • Capacity Group
        • Retrieve Board List
          GET
        • Create New Board
          POST
        • Retrieve Single Board
          GET
        • Update Single Board
          PUT
        • Remove Single Board
          DELETE
      • Stage
        • Retrieve Stage List
        • Create New Stage
        • Retrieve Single Stage
        • Update Single Stage
        • Remove Single Stage
      • Activity
        • Retrieve Activity List
        • Create New Activity
        • Retrieve Single Activity
        • Update Single Activity
        • Remove Single Activity
      • Resource
        • Retrieve Resource List
        • Create New Resource
        • Retrieve Single Resource
        • Update Single Resource
        • Remove Single Resource
      • Schedule
        • Retrieve Schedule List
        • Retrieve Schedule Year
        • Retrieve Schedule Month
        • Schedule Retrieve Day
      • Group
        • Retrieve Group List
        • Create New Group
        • Retrieve Single Group
        • Update Single Group
        • Remove Single Group
      • User
        • Retrieve User List
        • Retrieve Single User
        • Update Single User
    • Card Data
      • Collection
        • Custom Fields
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Collection List
        • Create New Collection
        • Retrieve Single Collection
        • Remove Single Collection
        • Move Collection to Backlog
        • Update Single Collection
        • Move Collection to Board
      • Card
        • Custom Field
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Card List
        • Create New Card
        • Retrieve Single Card
        • Update Single Card
        • Remove Single Card
        • Split Card
        • All Cards List
      • Attachment
        • Retrieve Attachment List
        • Upload New Attachment
        • Add New Attachment Link
        • Retrieve Single Attachment
        • Remove Single Attachment
      • Comment
        • Retrieve Comment List
        • Create New Comment
        • Retrieve Single Comment
        • Update Single Comment
        • Remove Single Comment
      • Checklist
        • Collection
          • Retrieve Collection Checklist List
          • Create New Collection Checklist
          • Retrieve Single Collection Checklist
          • Update Single Collection Checklist
          • Remove Single Collection Checklist
        • Card
          • Retrieve Card Checklist List
          • Create New Card Checklist
          • Retrieve Single Card Checklist
          • Update Single Card Checklist
          • Remove Single Card Checklist
      • Time Tracking
        • Retrieve TimeTracking List
        • Create New TimeTracking
        • Retrieve Single TimeTracking
        • Update Single TimeTracking
        • Remove Single TimeTracking
        • Export TimeTracking
      • Relations between cards
        • Retrieve CardRelation List
        • Create New CardRelation
        • Retrieve Single CardRelation
        • Remove Single CardRelation
    • Order Data
      • Address
      • Order
        • Retrieve Order List
        • Create New Order
        • Retrieve Single Order
        • Update Single Order
        • Remove Single Order
      • Row
        • Retrieve OrderRow List
        • Create New OrderRow
        • Retrieve Single OrderRow
        • Update Single OrderRow
        • Remove Single OrderRow
      • Item
        • Retrieve Item List
        • Create New Item
        • Retrieve Single Item
        • Update Single Item
        • Remove Single Item
      • Project
        • Retrieve Project List
        • Create New Project
        • Retrieve Single Project
        • Update Single Project
        • Remove Single Project
      • Relation
        • Retrieve Relation List
        • Create New Relation
        • Retrieve Single Relation
        • Update Single Relation
        • Remove Single Relation
      • Warehouse
        • Retrieve Warehouse List
        • Create New Warehouse
        • Retrieve Single Warehouse
        • Update Single Warehouse
        • Remove Single Warehouse
    • Webhook
      • Retrieve Webhook List
      • Create New Webhook
      • Retrieve Single Webhook
      • Update Single Webhook
      • Remove Single Webhook
    • Payload send to webhook url
      • Normal Object
      • Nested Object
      • Nested Object with Pivot
  1. Board

Retrieve Board List

GET
/board
Board
Retrieve the Board List

Request

Query Params
include
string 
optional
object(s) included in the dataset, see eager loading for more info.
Possible options are:
automations
with
string 
optional
object(s) included in the dataset, see eager loading for more info.
Possible options are:
checklists
collections
labels
resources - assigned to stage
restricted_users
stages
statuses
Header Params
x-api-key
string 
required
Default:
{{api_key}}
x-api-env
string 
required
Default:
{{api_env}}

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 GET 'https://api.vplan.com/v1/board' \
--header 'x-api-key;' \
--header 'x-api-env;'

Responses

🟢200OK
application/json
Body
count
integer <uint64>
optional
Total amount of items
>= 0
Default:
1
limit
integer <uint64>
optional
Max amount of items fetched
>= 0<= 1000
Default:
100
offset
integer <uint64>
optional
Offset so items may be paginated
>= 0
Default:
0
data
array [object {14}] 
optional
Items
id
string <uuid>
read-onlyoptional
Unique identifier
name
string 
optional
workdays
object (BoardWorkdays) 
optional
color
enum<string> 
optional
Allowed values:
bluebrownbubblegumcharcoalgreengreyindigolavendernavyoliveorangepinkpurpleraspberryredrubyskybluetealtransparentyellow
Default:
transparent
split_cards_by_activity
boolean 
optional
Default:
false
own_backlog
boolean 
optional
Default:
false
capacity_method
enum<string> 
optional
Allowed values:
estimated_timenoneremaining_time
Default:
estimated_time
visibility
enum<string> 
optional
Allowed values:
everyonerestricted
Default:
everyone
restricted_users
array [object {2}] 
required
dependency_behavior
enum<string> 
optional
Allowed values:
notifypushmaintain
Default:
notify
custom_fields
array[object (CustomField) {13}] 
optional
created_at
string <date-time>
read-onlyoptional
Date and time of creation
Example:
2024-04-11T10:22:15Z
updated_at
string <date-time>
read-onlyoptional
Date and time of last update
Example:
2024-04-11T10:22:15Z
archived_at
string <date-time> | null 
read-onlyoptional
Date and time that the object is archived
Example:
null
Example
{
  "count": 2,
  "limit": 100,
  "offset": 0,
  "data": [
    {
      "id": "3b2a0009-035c-452b-a8a0-d4e81a00edea",
      "name": "Construction Planning",
      "workdays": {
        "1": true,
        "2": true,
        "3": true,
        "4": true,
        "5": true,
        "6": false,
        "7": false
      },
      "custom_fields": [
        {
          "id": "9fa86cad-db8d-48ba-8e72-937fe2f0a394",
          "board_id": "3b2a0009-035c-452b-a8a0-d4e81a00edea",
          "name": "Address project",
          "type": "address",
          "scope": "collection",
          "options": null,
          "priority": 0,
          "created_at": "2024-04-03T13:45:50Z",
          "updated_at": "2024-04-03T13:45:50Z"
        },
        {
          "id": "39e26bc6-8a37-4b07-bb0c-dbe6bb7c5908",
          "board_id": "3b2a0009-035c-452b-a8a0-d4e81a00edea",
          "name": "Supplier",
          "type": "text",
          "scope": "collection",
          "options": null,
          "priority": 1,
          "created_at": "2024-04-03T13:45:50Z",
          "updated_at": "2024-04-03T13:45:50Z"
        }
      ],
      "color": "yellow",
      "split_cards_by_activity": false,
      "own_backlog": true,
      "capacity_method": "individual",
      "visibility": "everyone",
      "dependency_behavior": "maintain",
      "archived_at": null,
      "created_at": "2024-04-03T13:45:50Z",
      "updated_at": "2024-04-03T13:45:50Z"
    },
    {
      "id": "a75e4400-5456-43a1-ae4d-07b481f5cbe6",
      "name": "Content Planning",
      "workdays": {
        "1": true,
        "2": true,
        "3": true,
        "4": true,
        "5": true,
        "6": true,
        "7": true
      },
      "custom_fields": [
        {
          "id": "21ebdab1-3067-460b-8409-f1d0cf694a0f",
          "board_id": "a75e4400-5456-43a1-ae4d-07b481f5cbe6",
          "name": "Content ready?",
          "type": "checkbox",
          "scope": "collection",
          "options": null,
          "priority": 0,
          "created_at": "2024-04-03T13:46:04Z",
          "updated_at": "2024-04-03T13:46:04Z"
        }
      ],
      "color": "purple",
      "split_cards_by_activity": false,
      "own_backlog": false,
      "capacity_method": "individual",
      "visibility": "everyone",
      "dependency_behavior": "notify",
      "archived_at": null,
      "created_at": "2024-04-03T13:46:04Z",
      "updated_at": "2024-04-03T13:46:04Z"
    }
  ]
}
🟠401Not Logged In
Modified at 2025-04-22 11:37:34
Previous
Capacity Group
Next
Create New Board
Built with