Cloud REST API

Browse the available end points for the Ativo cloud API.

The REST endpoints below allow you to retrieve Ativo configuration data via an API token.

This page is for the Cloud API.

The Ativo Programs API is in BETA, meaning breaking changes can occur without notification. Please keep an eye on this page for updates. Contact support in case of questions.

Team

Get the list of teams

GEThttps://cloud-api.ativo.io/rest/api/1/team

Response

200

OK

Body

*/*

idinteger (int64)

keystring

namestring

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.ativo.io/rest/api/1/team', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "key": "text",
    "name": "text"
  }
]

Get a team configuration

GEThttps://cloud-api.ativo.io/rest/api/1/team/{id}

Path parameters

id*integer (int64)

Response

200

OK

Body

*/*

idinteger (int64)

keystring

namestring

modeenum

SCRUMKANBAN

estimationenum

STORY_POINTSMAN_DAYSNONE

configFilterConfigFilter (object)

boardBoardConfig (object)

typeenum

BOARDCUSTOM

isArchivedboolean

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.ativo.io/rest/api/1/team/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": 0,
  "key": "text",
  "name": "text",
  "mode": "SCRUM",
  "estimation": "STORY_POINTS",
  "configFilter": {
    "jiraFilterBody": {
      "id": "text"
    },
    "manualFilterBody": {
      "projects": {
        "selectionOn": "PROJECT",
        "values": [
          {
            "id": "text"
          }
        ]
      },
      "fieldFilters": [
        {
          "field": {
            "id": "text"
          },
          "values": [
            {
              "id": "text"
            }
          ],
          "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
          "operator": "IN"
        }
      ]
    },
    "filterMode": "JIRA"
  },
  "board": {
    "id": 0
  },
  "type": "BOARD",
  "isArchived": false
}

Get all team configurations

GEThttps://cloud-api.ativo.io/rest/api/1/teams

Response

200

OK

Body

*/*

idinteger (int64)

keystring

namestring

modeenum

SCRUMKANBAN

estimationenum

STORY_POINTSMAN_DAYSNONE

configFilterConfigFilter (object)

boardBoardConfig (object)

typeenum

BOARDCUSTOM

isArchivedboolean

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.ativo.io/rest/api/1/teams', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "key": "text",
    "name": "text",
    "mode": "SCRUM",
    "estimation": "STORY_POINTS",
    "configFilter": {
      "jiraFilterBody": {
        "id": "text"
      },
      "manualFilterBody": {
        "projects": {
          "selectionOn": "PROJECT",
          "values": [
            {
              "id": "text"
            }
          ]
        },
        "fieldFilters": [
          {
            "field": {
              "id": "text"
            },
            "values": [
              {
                "id": "text"
              }
            ],
            "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
            "operator": "IN"
          }
        ]
      },
      "filterMode": "JIRA"
    },
    "board": {
      "id": 0
    },
    "type": "BOARD",
    "isArchived": false
  }
]

Program (ART)

Get the list of programs (ARTs)

GEThttps://cloud-api.ativo.io/rest/api/1/program

Response

200

OK

Body

*/*

idinteger (int64)

keystring

namestring

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.ativo.io/rest/api/1/program', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "key": "text",
    "name": "text"
  }
]

Get a program (ART) configuration

GEThttps://cloud-api.ativo.io/rest/api/1/program/{id}

Path parameters

id*integer (int64)

Response

200

OK

Body

*/*

idinteger (int64)

keystring

namestring

combinedFilterCombinedConfigFilter (object)

teamsarray of TeamEntry (object)

isArchivedboolean

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.ativo.io/rest/api/1/program/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": 0,
  "key": "text",
  "name": "text",
  "combinedFilter": {
    "mode": "PROGRAM_FILTER_EPIC_AND_ISSUES_UNDER_EPIC",
    "epicMode": "PROGRAM_EPICS_IN_FILTER",
    "epicFilter": {
      "jiraFilterBody": {
        "id": "text"
      },
      "manualFilterBody": {
        "projects": {
          "selectionOn": "PROJECT",
          "values": [
            {
              "id": "text"
            }
          ]
        },
        "fieldFilters": [
          {
            "field": {
              "id": "text"
            },
            "values": [
              {
                "id": "text"
              }
            ],
            "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
            "operator": "IN"
          }
        ]
      },
      "filterMode": "JIRA"
    },
    "issueFilter": {
      "jiraFilterBody": {
        "id": "text"
      },
      "manualFilterBody": {
        "projects": {
          "selectionOn": "PROJECT",
          "values": [
            {
              "id": "text"
            }
          ]
        },
        "fieldFilters": [
          {
            "field": {
              "id": "text"
            },
            "values": [
              {
                "id": "text"
              }
            ],
            "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
            "operator": "IN"
          }
        ]
      },
      "filterMode": "JIRA"
    }
  },
  "teams": [
    {
      "id": 0,
      "key": "text",
      "name": "text"
    }
  ],
  "isArchived": false
}

Get all program (ART) configurations

GEThttps://cloud-api.ativo.io/rest/api/1/programs

Response

200

OK

Body

*/*

idinteger (int64)

keystring

namestring

combinedFilterCombinedConfigFilter (object)

teamsarray of TeamEntry (object)

isArchivedboolean

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.ativo.io/rest/api/1/programs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "key": "text",
    "name": "text",
    "combinedFilter": {
      "mode": "PROGRAM_FILTER_EPIC_AND_ISSUES_UNDER_EPIC",
      "epicMode": "PROGRAM_EPICS_IN_FILTER",
      "epicFilter": {
        "jiraFilterBody": {
          "id": "text"
        },
        "manualFilterBody": {
          "projects": {
            "selectionOn": "PROJECT",
            "values": [
              {
                "id": "text"
              }
            ]
          },
          "fieldFilters": [
            {
              "field": {
                "id": "text"
              },
              "values": [
                {
                  "id": "text"
                }
              ],
              "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
              "operator": "IN"
            }
          ]
        },
        "filterMode": "JIRA"
      },
      "issueFilter": {
        "jiraFilterBody": {
          "id": "text"
        },
        "manualFilterBody": {
          "projects": {
            "selectionOn": "PROJECT",
            "values": [
              {
                "id": "text"
              }
            ]
          },
          "fieldFilters": [
            {
              "field": {
                "id": "text"
              },
              "values": [
                {
                  "id": "text"
                }
              ],
              "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
              "operator": "IN"
            }
          ]
        },
        "filterMode": "JIRA"
      }
    },
    "teams": [
      {
        "id": 0,
        "key": "text",
        "name": "text"
      }
    ],
    "isArchived": false
  }
]

Period (PI)

Get the list of periods (PIs)

GEThttps://cloud-api.ativo.io/rest/api/1/period

Response

200

OK

Body

*/*

idinteger (int64)

keystring

namestring

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.ativo.io/rest/api/1/period', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "key": "text",
    "name": "text"
  }
]

Get a period (PI) configuration

GEThttps://cloud-api.ativo.io/rest/api/1/period/{id}

Path parameters

id*integer (int64)

Response

200

OK

Body

*/*

idinteger (int64)

keystring

namestring

sprintsarray of Sprint (object)

programIncrementsarray of ProgramIncrementInPeriod (object)

isArchivedboolean

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.ativo.io/rest/api/1/period/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": 0,
  "key": "text",
  "name": "text",
  "sprints": [
    {
      "id": 0,
      "key": "text",
      "name": "text",
      "closed": false,
      "startDate": "text",
      "endDate": "text",
      "teamSprints": [
        {
          "sprintJiraId": 0,
          "teamKey": "text"
        }
      ]
    }
  ],
  "programIncrements": [
    {
      "programId": 0,
      "combinedFilter": {
        "mode": "PROGRAM_FILTER_EPIC_AND_ISSUES_UNDER_EPIC",
        "epicMode": "PROGRAM_EPICS_IN_FILTER",
        "epicFilter": {
          "jiraFilterBody": {
            "id": "text"
          },
          "manualFilterBody": {
            "projects": {
              "selectionOn": "PROJECT",
              "values": [
                {
                  "id": "text"
                }
              ]
            },
            "fieldFilters": [
              {
                "field": {
                  "id": "text"
                },
                "values": [
                  {
                    "id": "text"
                  }
                ],
                "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
                "operator": "IN"
              }
            ]
          },
          "filterMode": "JIRA"
        },
        "issueFilter": {
          "jiraFilterBody": {
            "id": "text"
          },
          "manualFilterBody": {
            "projects": {
              "selectionOn": "PROJECT",
              "values": [
                {
                  "id": "text"
                }
              ]
            },
            "fieldFilters": [
              {
                "field": {
                  "id": "text"
                },
                "values": [
                  {
                    "id": "text"
                  }
                ],
                "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
                "operator": "IN"
              }
            ]
          },
          "filterMode": "JIRA"
        }
      },
      "teams": [
        {
          "id": 0,
          "key": "text",
          "name": "text"
        }
      ]
    }
  ],
  "isArchived": false
}

Get all period (PI) configurations

GEThttps://cloud-api.ativo.io/rest/api/1/periods

Response

200

OK

Body

*/*

idinteger (int64)

keystring

namestring

sprintsarray of Sprint (object)

programIncrementsarray of ProgramIncrementInPeriod (object)

isArchivedboolean

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.ativo.io/rest/api/1/periods', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "key": "text",
    "name": "text",
    "sprints": [
      {
        "id": 0,
        "key": "text",
        "name": "text",
        "closed": false,
        "startDate": "text",
        "endDate": "text",
        "teamSprints": [
          {
            "sprintJiraId": 0,
            "teamKey": "text"
          }
        ]
      }
    ],
    "programIncrements": [
      {
        "programId": 0,
        "combinedFilter": {
          "mode": "PROGRAM_FILTER_EPIC_AND_ISSUES_UNDER_EPIC",
          "epicMode": "PROGRAM_EPICS_IN_FILTER",
          "epicFilter": {
            "jiraFilterBody": {
              "id": "text"
            },
            "manualFilterBody": {
              "projects": {
                "selectionOn": "PROJECT",
                "values": [
                  {
                    "id": "text"
                  }
                ]
              },
              "fieldFilters": [
                {
                  "field": {
                    "id": "text"
                  },
                  "values": [
                    {
                      "id": "text"
                    }
                  ],
                  "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
                  "operator": "IN"
                }
              ]
            },
            "filterMode": "JIRA"
          },
          "issueFilter": {
            "jiraFilterBody": {
              "id": "text"
            },
            "manualFilterBody": {
              "projects": {
                "selectionOn": "PROJECT",
                "values": [
                  {
                    "id": "text"
                  }
                ]
              },
              "fieldFilters": [
                {
                  "field": {
                    "id": "text"
                  },
                  "values": [
                    {
                      "id": "text"
                    }
                  ],
                  "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
                  "operator": "IN"
                }
              ]
            },
            "filterMode": "JIRA"
          }
        },
        "teams": [
          {
            "id": 0,
            "key": "text",
            "name": "text"
          }
        ]
      }
    ],
    "isArchived": false
  }
]

Objectives

Get the program and team objectives for a PI

GEThttps://cloud-api.ativo.io/rest/api/1/objectives/{programId}/{periodId}

Path parameters

programId*integer (int64)

periodId*integer (int64)

Response

200

OK

Body

*/*

idinteger (int64)

keystring

namestring

programIdinteger (int64)

periodIdinteger (int64)

objectivesarray of Objective (object)

showEpicLinksboolean

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.ativo.io/rest/api/1/objectives/{programId}/{periodId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": 0,
  "key": "text",
  "name": "text",
  "programId": 0,
  "periodId": 0,
  "objectives": [
    {
      "level": "PROGRAM",
      "teamId": 0,
      "commitment": "COMMITTED",
      "label": "text",
      "plannedValue": 0,
      "deliveredValue": 0,
      "epicIds": [
        "text"
      ]
    }
  ],
  "showEpicLinks": false
}