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
        • View
          • Create New BoardView
        • 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
        • Schedule
        • Schedule Deviation
          • Retrieve Deviation List
          • Create New Schedule Deviation
          • Retrieve Single Schedule Deviation
          • Update Single Schedule Deviation
          • Remove Single Schedule Deviation
        • 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
        • Invite User
        • Retrieve User List
        • Retrieve Single User
        • Update Single User
      • Space
        • Retrieve Space List
        • Create New Space
        • Retrieve Single Space
        • Update Single Space
        • Remove Single Space
    • Card Data
      • Collection
        • Custom Fields
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Collection List
        • Create New Collection
        • Retrieve Single Collection
        • Update Single Collection
        • Remove Single Collection
        • Move Collection to Board
        • Move Collection to Backlog
      • 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
      • Card Relation
    • 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
      • Payload send to webhook url
        • Normal Object
        • Nested Object
        • Nested Object with Pivot
      • Retrieve Webhook List
      • Create New Webhook
      • Retrieve Single Webhook
      • Update Single Webhook
      • Remove Single Webhook
  1. Board

Retrieve Board List

GET
/board
Retrieve the Board List

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
API Key
Add parameter in header
x-api-env
Example:
x-api-env: ********************
or
Query Params

Request Code 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

Example
{
    "count": 2,
    "limit": 100,
    "offset": 0,
    "data": [
        {
            "id": "26f48a32-2e38-432f-93be-ba1b82b48962",
            "name": "Production X",
            "workdays": {
                "1": true,
                "2": true,
                "3": true,
                "4": true,
                "5": true,
                "6": false,
                "7": false
            },
            "color": "teal",
            "split_cards_by_activity": true,
            "own_backlog": false,
            "capacity_method": "estimated_time",
            "visibility": "everyone",
            "dependency_behavior": "notify",
            "card_lock_options": [
                "card.move",
                "card.edit.name",
                "card.edit.description",
                "card.edit.status",
                "card.edit.date",
                "card.edit.activities",
                "card.edit.resources",
                "card.edit.labels",
                "card.split",
                "card.clone",
                "card.delete",
                "time.register",
                "time.edit.other",
                "time.edit.own",
                "time.status",
                "checklist.add",
                "checklist.delete",
                "checklist.edit",
                "custom.field.card"
            ],
            "archived_at": null,
            "created_at": "2025-07-16T07:28:36Z",
            "updated_at": "2025-07-16T07:33:48Z",
            "permission_set": "can_manage",
            "custom_fields": [
                {
                    "id": "67e512f1-ff1f-47da-8b57-9d7ecc39cbd0",
                    "board_id": "26f48a32-2e38-432f-93be-ba1b82b48962",
                    "name": "Customer",
                    "type": "text",
                    "scope": "collection",
                    "options": null,
                    "priority": 0,
                    "created_at": "2025-07-16T07:31:44Z",
                    "updated_at": "2025-07-16T07:31:44Z"
                },
                {
                    "id": "a65cd796-3a27-4c6f-b91c-074f960987c9",
                    "board_id": "26f48a32-2e38-432f-93be-ba1b82b48962",
                    "name": "Quantity",
                    "type": "number",
                    "scope": "collection",
                    "options": {
                        "unit": "pc",
                        "decimals": 0,
                        "align": "right",
                        "preview": "123.456 pc"
                    },
                    "priority": 1,
                    "created_at": "2025-07-16T07:31:44Z",
                    "updated_at": "2025-07-16T07:31:44Z"
                },
                {
                    "id": "0ed24e46-dfcb-48b1-b291-1b645fedcc26",
                    "board_id": "26f48a32-2e38-432f-93be-ba1b82b48962",
                    "name": "Delivery date",
                    "type": "date",
                    "scope": "collection",
                    "options": {
                        "format": ""
                    },
                    "priority": 2,
                    "created_at": "2025-07-16T07:31:44Z",
                    "updated_at": "2025-07-16T07:31:44Z"
                },
                {
                    "id": "f85d0610-a47d-4c55-a5be-1400bc3b42ed",
                    "board_id": "26f48a32-2e38-432f-93be-ba1b82b48962",
                    "name": "Shipping address",
                    "type": "address",
                    "scope": "collection",
                    "options": null,
                    "priority": 3,
                    "created_at": "2025-07-16T07:31:44Z",
                    "updated_at": "2025-07-16T07:31:44Z"
                },
                {
                    "id": "c22d6cd7-d069-452c-a2e5-d9517c502f93",
                    "board_id": "26f48a32-2e38-432f-93be-ba1b82b48962",
                    "name": "Quality check",
                    "type": "checkbox",
                    "scope": "collection",
                    "options": null,
                    "priority": 4,
                    "created_at": "2025-07-16T07:31:44Z",
                    "updated_at": "2025-07-16T07:31:44Z"
                },
                {
                    "id": "899c4dc7-7398-406d-a6a6-128d5f6bf537",
                    "board_id": "26f48a32-2e38-432f-93be-ba1b82b48962",
                    "name": "Colour",
                    "type": "select",
                    "scope": "collection",
                    "options": {
                        "values": [
                            {
                                "description": "Red",
                                "color": "ruby"
                            },
                            {
                                "description": "Blue",
                                "color": "navy"
                            },
                            {
                                "description": "Purple",
                                "color": "purple"
                            }
                        ],
                        "default": ""
                    },
                    "priority": 5,
                    "created_at": "2025-07-16T07:31:44Z",
                    "updated_at": "2025-07-16T07:31:44Z"
                },
                {
                    "id": "4ebe2cca-ec99-435a-8ee5-1e9b51fc4e72",
                    "board_id": "26f48a32-2e38-432f-93be-ba1b82b48962",
                    "name": "Extra information",
                    "type": "textarea",
                    "scope": "collection",
                    "options": null,
                    "priority": 6,
                    "created_at": "2025-07-16T07:31:44Z",
                    "updated_at": "2025-07-16T07:31:44Z"
                },
                {
                    "id": "e6ce2169-9c3f-4cba-b028-a535798783d6",
                    "board_id": "26f48a32-2e38-432f-93be-ba1b82b48962",
                    "name": "E-mail",
                    "type": "email",
                    "scope": "collection",
                    "options": null,
                    "priority": 7,
                    "created_at": "2025-07-16T07:31:44Z",
                    "updated_at": "2025-07-16T07:31:44Z"
                },
                {
                    "id": "cc7e97ed-fce4-4b18-a4d1-7b3ea9dbea3e",
                    "board_id": "26f48a32-2e38-432f-93be-ba1b82b48962",
                    "name": "Phone number",
                    "type": "phone",
                    "scope": "collection",
                    "options": null,
                    "priority": 8,
                    "created_at": "2025-07-16T07:31:44Z",
                    "updated_at": "2025-07-16T07:31:44Z"
                },
                {
                    "id": "74053d28-25e7-4e2d-8cf4-572296f90593",
                    "board_id": "26f48a32-2e38-432f-93be-ba1b82b48962",
                    "name": "Website",
                    "type": "link",
                    "scope": "collection",
                    "options": null,
                    "priority": 9,
                    "created_at": "2025-07-16T07:31:44Z",
                    "updated_at": "2025-07-16T07:31:44Z"
                },
                {
                    "id": "0ca35b1f-72eb-48ec-81dd-db1503d5b5e2",
                    "board_id": "26f48a32-2e38-432f-93be-ba1b82b48962",
                    "name": "Signature",
                    "type": "drawing",
                    "scope": "collection",
                    "options": null,
                    "priority": 10,
                    "created_at": "2025-07-16T07:31:44Z",
                    "updated_at": "2025-07-16T07:31:44Z"
                }
            ]
        },
        {
            "id": "42dd60d6-b467-47cc-935c-d14561bddc06",
            "name": "Technicians Y",
            "workdays": {
                "1": true,
                "2": true,
                "3": true,
                "4": true,
                "5": true,
                "6": false,
                "7": false
            },
            "color": "transparent",
            "split_cards_by_activity": false,
            "own_backlog": false,
            "capacity_method": "estimated_time",
            "visibility": "everyone",
            "dependency_behavior": "notify",
            "card_lock_options": [
                "card.move",
                "card.edit.name",
                "card.edit.description",
                "card.edit.status",
                "card.edit.date",
                "card.edit.activities",
                "card.edit.resources",
                "card.edit.labels",
                "card.split",
                "card.clone",
                "card.delete",
                "time.register",
                "time.edit.other",
                "time.edit.own",
                "time.status",
                "checklist.add",
                "checklist.delete",
                "checklist.edit",
                "custom.field.card"
            ],
            "archived_at": null,
            "created_at": "2025-07-16T07:51:53Z",
            "updated_at": "2025-07-16T07:51:53Z",
            "permission_set": "can_manage",
            "custom_fields": [
                {
                    "id": "c445e8c5-4512-4bd4-9f82-a05662a41f34",
                    "board_id": "42dd60d6-b467-47cc-935c-d14561bddc06",
                    "name": "Number of installments",
                    "type": "number",
                    "scope": "collection",
                    "options": {
                        "unit": "",
                        "decimals": 0,
                        "align": "left",
                        "preview": " 123,456"
                    },
                    "priority": 0,
                    "created_at": "2025-07-16T07:53:29Z",
                    "updated_at": "2025-07-16T07:53:29Z"
                },
                {
                    "id": "64e07695-0550-451e-a9df-cdc9bb918804",
                    "board_id": "42dd60d6-b467-47cc-935c-d14561bddc06",
                    "name": "Note 1",
                    "type": "text",
                    "scope": "collection",
                    "options": null,
                    "priority": 1,
                    "created_at": "2025-07-16T07:53:29Z",
                    "updated_at": "2025-07-16T07:53:29Z"
                },
                {
                    "id": "7dc57128-8522-4612-adaa-9e637613ce90",
                    "board_id": "42dd60d6-b467-47cc-935c-d14561bddc06",
                    "name": "Note 2",
                    "type": "text",
                    "scope": "card",
                    "options": null,
                    "priority": 2,
                    "created_at": "2025-07-16T07:53:29Z",
                    "updated_at": "2025-07-16T07:53:29Z"
                }
            ]
        }
    ]
}
🟠401Not Logged In
Modified at 2025-07-22 14:20:42
Previous
Create New BoardView
Next
Create New Board
Built with