API Documentation

API Endpoint

Teams

Teams

Supported filter params

  • color_id

  • id

  • name

Supported sort params

  • name
GET /api/v2/teams
Requestsreturns teams

GET  /api/v2/teams

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": "10",
      "type": "teams",
      "attributes": {
        "color_id": "1",
        "icon_id": null,
        "name": "A team"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2065"
          }
        },
        "members": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "11",
      "type": "teams",
      "attributes": {
        "color_id": "1",
        "icon_id": null,
        "name": "A team"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2065"
          }
        },
        "members": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "12",
      "type": "teams",
      "attributes": {
        "color_id": "1",
        "icon_id": null,
        "name": "A team"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2065"
          }
        },
        "members": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/teams?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/teams?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 3,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get teams
GET/api/v2/teams

GET /api/v2/teams/1
Requestsreturns team

GET  /api/v2/teams/13

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": "13",
    "type": "teams",
    "attributes": {
      "color_id": "1",
      "icon_id": null,
      "name": "A team"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2066"
        }
      },
      "members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets a team
GET/api/v2/teams/{id}

URI Parameters
HideShow
id
number (required) Example: 1

team id

POST /api/v2/teams
Requestscreates teamreturns error

POST  /api/v2/teams

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": "teams",
    "attributes": {
      "name": "B team"
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "15",
    "type": "teams",
    "attributes": {
      "color_id": null,
      "icon_id": null,
      "name": "B team"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2067"
        }
      },
      "members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Create a team
POST/api/v2/teams

URI Parameters
HideShow
name
string (required) Example: Name

name

PATCH /api/v2/teams/1
Requestsupdates teamreturns error

PATCH  /api/v2/teams/17

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": "teams",
    "attributes": {
      "name": "B team"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "17",
    "type": "teams",
    "attributes": {
      "color_id": "1",
      "icon_id": null,
      "name": "B team"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2069"
        }
      },
      "members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Update a team
PATCH/api/v2/teams/{id}

URI Parameters
HideShow
id
number (required) Example: 1

team id

DELETE /api/v2/teams/1
Requestssoft deletes the team

DELETE  /api/v2/teams/19

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
Responses204
This response has no content.

Deletes a team
DELETE/api/v2/teams/{id}

URI Parameters
HideShow
id
number (required) Example: 1

team id

Generated by aglio on 29 May 2025