Teams

List of valid attributes:

Attribute	Description	Specifics
account_id	ID of the account the team belongs to	Cannot be set
discarded_at	Null or timestamp of removal	Cannot be set
name	Name of the team	Must be set, Must be unique within account
parent_team_id	ID of parent team	Must be set on all non-default teams

The following relationships can be included in requests:

Relationship	Type
parent_team	belongs_to
team_memberships	has_many

Meta data: Permissions

Group	Description
actions	Contains permissions to edit or delete a team
team_memberships	Returns permissions if current user can create, edit or delete roles of users inside team

Create

Example request:

{
  "data": {
    "type": "team",
    "attributes": {
      "name": "Team"
    }
  }
}

Example response:

{
  "data": {
    "id": "3aab0a84-8ed3-4ddf-8572-f1799bb60e0a",
    "type": "team",
    "attributes": {
      ...
    }
  }
}

This endpoint creates a team.

HTTP Request

POST /api/v1/teams

Update

Example request:

{
  "data": {
    "type": "team",
    "attributes": {
      "name": "Updated Team"
    }
  }
}

Example response:

{
  "data": {
    "id": "3aab0a84-8ed3-4ddf-8572-f1799bb60e0a",
    "type": "team",
    "attributes": {
      ...
    }
  }
}

This endpoint updates a team.

HTTP Request

PUT /api/v1/teams/:team_id

URL Parameters

Parameter	Description
team_id	ID of the team to be updated

Show

Example response:

{
  "data": {
    "id": "3aab0a84-8ed3-4ddf-8572-f1799bb60e0a",
    "type": "team",
    "attributes": {
      ...
    }
  }
}

This endpoint returns a team.

HTTP Request

GET /api/v1/teams/:team_id

URL Parameters

Parameter	Description
team_id	The ID of the team to return

List

Example response:

{
  "data": [
    {
      "id": "3aab0a84-8ed3-4ddf-8572-f1799bb60e0a",
      "type": "team",
      "attributes": {
        ...
      }
    },
    {
      ...
    }
  ]
}

This endpoint returns teams.

HTTP Request

GET /api/v1/teams

Delete

Example response:

{
  "data": {
    "id": "3aab0a84-8ed3-4ddf-8572-f1799bb60e0a",
    "type": "team",
    "attributes": {
      ...
    }
  }
}

This endpoint deletes a team.

HTTP Request

DELETE /api/v1/teams/:team_id

URL Parameters

Parameter	Description
team_id	The ID of the team to delete