Stage

Adding Stages to a Board allows you to track your Projects progression from an initial idea right through to completion. Once defined, the Stages are available on the Board and can be used to filter Projects. For a full description of the model see the Stage model definition.

List stages

The collection of stages on the Capsule account.

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

Query Parameters

Name Type Description
status String

The status of the stage. Accepted values are active, archived, all. Default is active.
includeOnDeletedBoard Boolean

If true returns stages on archived boards. Default is false.
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 stages which is an array of Stage 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/stages?page=2>; rel="next" 
{
  "stages" : [ {
    "name" : "Planning",
    "description" : "How to do what needs to be done",
    "id" : 1,
    "board" : {
      "id" : 34,
      "name" : "Projects"
    },
    "displayOrder" : 1,
    "createdAt" : "2022-06-10T14:39:14Z",
    "updatedAt" : "2022-06-10T14:39:14Z"
  }, {
    "name" : "Concept",
    "id" : 156,
    "board" : {
      "id" : 35,
      "name" : "Design"
    },
    "displayOrder" : 2,
    "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.

List stages by board

List stages associated with a board.

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

Query Parameters

Name Type Description
status String

The status of the stage. Accepted values are active, archived, 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 stages which is an array of Stage objects.

HTTP/1.1 200
Link: <https://api.capsulecrm.com/api/v2/boards/34/stages?page=2&perPage=2>; rel="next" 
{
  "stages" : [ {
    "name" : "Planning",
    "description" : "How to do what needs to be done",
    "id" : 1,
    "board" : {
      "id" : 34,
      "name" : "Projects"
    },
    "displayOrder" : 1,
    "createdAt" : "2022-06-10T14:39:14Z",
    "updatedAt" : "2022-06-10T14:39:14Z"
  }, {
    "name" : "Project Brief",
    "description" : "Define what needs to be done",
    "id" : 2,
    "board" : {
      "id" : 34,
      "name" : "Projects"
    },
    "displayOrder" : 2,
    "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 stage

Show a specific stage.

GET
https://api.capsulecrm.com/api/v2/stages/{stageId}

Response

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

HTTP/1.1 200 
{
  "stage" : {
    "name" : "Project Brief",
    "description" : "Define what needs to be done",
    "id" : 154,
    "board" : {
      "id" : 34,
      "name" : "Projects"
    },
    "displayOrder" : 1,
    "createdAt" : "2022-06-10T14:39:14Z",
    "updatedAt" : "2022-06-10T14:39:14Z"
  }
}

Create stage

Creates a new stage. The body must contain an object with a single property stage which must be a Stage object. This operation requires the authenticated user to have an Administrator role on the Capsule account.

POST
https://api.capsulecrm.com/api/v2/stages
          {
  "stage" : {
    "name" : "Project Brief",
    "description" : "Define what needs to be done",
    "board" : 34,
    "displayOrder" : 1
  }
}

Response

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

HTTP/1.1 201
Location: https://api.capsulecrm.com/api/v2/stages/154 
{
  "stage" : {
    "name" : "Project Brief",
    "description" : "Define what needs to be done",
    "id" : 154,
    "board" : {
      "id" : 34,
      "name" : "Projects"
    },
    "displayOrder" : 1,
    "createdAt" : "2022-06-10T14:39:14Z",
    "updatedAt" : "2022-06-10T14:39:14Z"
  }
}

Headers:

Name Type Description
Location String

The URL that identifies the new stage.

Update stage

Update the name, description or position of a stage. The body must contain an object with a single property stage which must be a Stage object. This operation requires the authenticated user to have an Administrator role on the Capsule account.

PUT
https://api.capsulecrm.com/api/v2/stages/{stageId}
          {
  "stage" : {
    "name" : "Planning",
    "description" : "How to do what needs to be done",
    "displayOrder" : 2
  }
}

Response

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

HTTP/1.1 200 
{
  "stage" : {
    "name" : "Planning",
    "description" : "How to do what needs to be done",
    "id" : 1,
    "board" : {
      "id" : 34,
      "name" : "Projects"
    },
    "displayOrder" : 2,
    "createdAt" : "2022-06-10T14:39:14Z",
    "updatedAt" : "2022-06-10T14:39:14Z"
  }
}

Delete stage

Removes a stage from the Capsule account. You cannot delete a stage while it is still being used on an open project. First you need to change or remove the stage on all such projects. This operation requires the authenticated user to have an Administrator role on the Capsule account.

DELETE
https://api.capsulecrm.com/api/v2/stages/{stageId}

Response

Returns HTTP status code 204. Returns an empty body if the stage was successfully deleted.

HTTP/1.1 204