Team

These endpoints allow the retrieval of teams on this account.

List Teams

List all the teams on this Capsule account.

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

Query Parameters

Name Type Description
embed Array of String

Can be used to specify extra entities to fully include in the result. If provided, should be a comma separated list of strings. Can be empty or memberships.

Response

Returns HTTP status code 200. The body of the response will contain an object with a single property teams which is an array of Team objects.

In the case of an invalid request, an error message will be returned, as described in the errors section.

HTTP/1.1 200
{
  "teams" : [ {
    "id" : 3,
    "name" : "The North",
    "description" : null,
    "createdAt" : "2018-02-23T11:46:50Z",
    "updatedAt" : "2018-02-26T12:48:22Z"
  }, {
    "id" : 4,
    "name" : "The South",
    "description" : null,
    "createdAt" : "2018-02-23T11:46:56Z",
    "updatedAt" : "2018-02-26T12:48:31Z"
  }, {
    "id" : 5,
    "name" : "Executives",
    "description" : null,
    "createdAt" : "2018-03-01T10:38:55Z",
    "updatedAt" : "2018-03-01T10:39:01Z"
  } ]
}

Show Team

Retrieve a specific team by its unique id

GET
https://api.capsulecrm.com/api/v2/teams/{teamId}

Query Parameters

Name Type Description
embed Array of String

Can be used to specify extra entities to fully include in the result. If provided, should be a comma separated list of strings. Can be empty or memberships.

Response

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

HTTP/1.1 200
{
  "user" : {
    "id" : 3,
    "name" : "The North",
    "description" : null,
    "createdAt" : "2018-02-23T11:46:50Z",
    "updatedAt" : "2018-02-26T12:48:22Z"
  }
}