Board

A Board is a visual process, made up of Stages, that a Project moves through as it goes from planning through to completion. For a full description of the model see the Board model definition.

List boards

The collection of boards on the Capsule account.

GET
https://api.capsulecrm.com/api/v2/boards

Query Parameters

Name Type Description
q String

The full or partial name of a board.
status String

The status of the board. Accepted values are active, archived, nonempty, all. Default is active.
page Integer

The page of results to return. Default: 1
perPage Integer

The number of entities to return per page. Value must be between 1 and 100. Default: 50

Response

Returns HTTP status code 200. The body of the response will contain an object with a single property boards which is an array of Board objects. In the case of an invalid request, an error message will be returned, as described in the errors section.

HTTP/1.1 200
Link: <https://api.capsulecrm.com/api/v2/boards?page=4>; rel="next" 
{
  "boards" : [ {
    "id" : 13648,
    "name" : "Design",
    "description" : "Workflow for designers",
    "createdAt" : "2022-06-10T16:26:46Z",
    "updatedAt" : "2022-06-10T16:26:46Z"
  }, {
    "id" : 13647,
    "name" : "Projects",
    "description" : "Track your project's progress from the initial outline through to completion",
    "createdAt" : "2022-06-10T14:39:14Z",
    "updatedAt" : "2022-06-10T14:39:14Z"
  } ]
}

Headers:

Name Type Description
Link String

Links to the next and previous pages, encoded as defined in RFC 5988.

Show board

Show a specific board.

GET
https://api.capsulecrm.com/api/v2/boards/{boardId}

Response

Returns HTTP status code 200. The body of the response will contain an object with a single property board which is a Board object.

HTTP/1.1 200 
{
  "board" : {
    "id" : 13648,
    "name" : "Design",
    "description" : "Workflow for designers",
    "createdAt" : "2022-06-10T16:26:46Z",
    "updatedAt" : "2022-06-10T16:26:46Z"
  }
}

Create board

Creates a new board. The body must contain an object with a single property board which must be a Board object. Capsule accounts can have at most 30 active (non-archived) boards at any one time. This operation requires the authenticated user to have an Administrator role on the Capsule account.

POST
https://api.capsulecrm.com/api/v2/boards
          {
  "board" : {
    "name" : "Design",
    "description" : "Workflow for designers"
  }
}

Response

Returns HTTP status code 201. The body of the response will contain the board as it was stored in Capsule.

HTTP/1.1 201
Location: https://api.capsulecrm.com/api/v2/boards/13648 
{
  "board" : {
    "id" : 13648,
    "name" : "Design",
    "description" : "Workflow for designers",
    "createdAt" : "2022-06-10T16:26:46Z",
    "updatedAt" : "2022-06-10T16:26:46Z"
  }
}

Headers:

Name Type Description
Location String

The URL that identifies the new board.

Update board

Update an existing board. The body must contain an object with a single property board which must be a Board object. Fields that are not included in the request will remain unchanged. This operation requires the authenticated user to have an Administrator role on the Capsule account.

PUT
https://api.capsulecrm.com/api/v2/boards/{boardId}
          {
  "board" : {
    "name" : "Design"
  }
}

Response

Returns HTTP status code 200. All good

HTTP/1.1 200 
{
  "board" : {
    "id" : 13648,
    "name" : "Design",
    "description" : "Workflow for designers",
    "createdAt" : "2022-06-10T16:26:46Z",
    "updatedAt" : "2022-06-10T16:26:46Z"
  }
}

Archive board

Archive the specific board. This operation requires the authenticated user to have an Administrator role on the Capsule account.

DELETE
https://api.capsulecrm.com/api/v2/boards/{boardId}

Response

Returns HTTP status code 204. Returns status code 204 with an empty body if the board was successfully archived.

HTTP/1.1 204

Restore board

Restore an archived board. This operation requires the authenticated user to have an Administrator role on the Capsule account.

POST
https://api.capsulecrm.com/api/v2/boards/{boardId}/restore

Response

Returns HTTP status code 200. The body of the response will contain an object with a single property board which is a Board object. In the case of an invalid request, an error message will be returned, as described in the errors section.

HTTP/1.1 200 
{
  "board" : {
    "id" : 13648,
    "name" : "Design",
    "description" : "Workflow for designers",
    "createdAt" : "2022-06-10T16:26:46Z",
    "updatedAt" : "2022-06-10T16:26:46Z"
  }
}