API Documentation

API Endpoint

Boards

Boards

The Board object represents a board within the project management system. It sits between Projects and Task lists, meaning it belongs to a project and contains multiple task lists.

In the application, boards are currently referred to as folders.

You can find out more about boards in our Help documentation: Boards

Following diagram shows boards in our data hierarchy:

Board diagram

Supported filter params

  • id

  • project_id (array)

  • status (active: 1, archived: 2)

Supported relationship filter params

  • project
GET /api/v2/boards
Requestsreturns boards

GET  /api/v2/boards?filter[project_id]=31

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [],
  "links": {
    "first": "http://api-test.productive.io/api/v2/boards?filter%5Bproject_id%5D=31&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/boards?filter%5Bproject_id%5D=31&page%5Bnumber%5D=0&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 0,
    "total_count": 0,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get boards
GET/api/v2/boards

GET /api/v2/boards/1
Requestsreturns board

GET  /api/v2/boards/11

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "11",
    "type": "boards",
    "attributes": {
      "name": "board name",
      "position": null,
      "placement": null,
      "archived_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "84"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets a board
GET/api/v2/boards/{id}

URI Parameters
HideShow
id
number (required) Example: 1

board id

POST /api/v2/boards
Requestscreates boardreturns error

POST  /api/v2/boards

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "boards",
    "attributes": {
      "name": "test name"
    },
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "33"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "13",
    "type": "boards",
    "attributes": {
      "name": "test name",
      "position": null,
      "placement": null,
      "archived_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "85"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Create a board
POST/api/v2/boards

URI Parameters
HideShow
name
string (required) Example: Name

name

PATCH /api/v2/boards/1
Requestsupdates boardreturns error

PATCH  /api/v2/boards/14

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "boards",
    "attributes": {
      "name": "new name"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "14",
    "type": "boards",
    "attributes": {
      "name": "new name",
      "position": null,
      "placement": null,
      "archived_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "88"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Update a board
PATCH/api/v2/boards/{id}

URI Parameters
HideShow
id
number (required) Example: 1

board id

PATCH /api/v2/boards/1/archive
Requestsarchives board

PATCH  /api/v2/boards/17/archive

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "17",
    "type": "boards",
    "attributes": {
      "name": "board name",
      "position": null,
      "placement": null,
      "archived_at": "2025-03-26T05:03:33.000+01:00"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "91"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Archives a board
PATCH/api/v2/boards/{id}/archive

URI Parameters
HideShow
id
number (required) Example: 1

board id

PATCH /api/v2/boards/1/restore
Requestsrestores board

PATCH  /api/v2/boards/18/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "18",
    "type": "boards",
    "attributes": {
      "name": "board name",
      "position": null,
      "placement": 1010000,
      "archived_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "92"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Restores a board
PATCH/api/v2/boards/{id}/restore

URI Parameters
HideShow
id
number (required) Example: 1

board id

POST /api/v2/boards/copy
Requestscopy from templatecopy from templatecopy from templatecopy from template

POST  /api/v2/boards/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "boards",
    "attributes": {
      "name": "copy board",
      "template_id": 19,
      "project_id": 39,
      "copy_task_lists": true,
      "copy_open_tasks": true,
      "copy_assignees": true
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "20",
    "type": "boards",
    "attributes": {
      "name": "copy board",
      "position": null,
      "placement": null,
      "archived_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "93"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Copy a board
POST/api/v2/boards/copy

URI Parameters
HideShow
id
number (required) Example: 1

board id

PATCH /api/v2/boards/1/move
Requestsmoves board to new projectreturns errors

PATCH  /api/v2/boards/29/move

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "boards",
    "attributes": {
      "project_id": 53
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "29",
    "type": "boards",
    "attributes": {
      "name": "board name",
      "position": null,
      "placement": null,
      "archived_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "97"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Move a board
PATCH/api/v2/boards/{id}/move

URI Parameters
HideShow
id
number (required) Example: 1

board id

PATCH /api/v2/boards/1/reposition
Requestsupdates placement

PATCH  /api/v2/boards/31/reposition

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "boards",
    "attributes": {
      "move_before_id": 32
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "31",
    "type": "boards",
    "attributes": {
      "name": "board name",
      "position": null,
      "placement": 90000,
      "archived_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "99"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Repoisition a board
PATCH/api/v2/boards/{id}/reposition

URI Parameters
HideShow
id
number (required) Example: 1

board id

Generated by aglio on 26 Mar 2025