# BigPicture Documentation > Documentation for BigPicture ## API Reference - [What is BigPicture?](https://developer.bigpicture.one/reference/whatisbigpicture.md) - [Authentication and authorization](https://developer.bigpicture.one/reference/apitokens.md) - [Base URL](https://developer.bigpicture.one/reference/baseurl.md) - [API response structure](https://developer.bigpicture.one/reference/apiresponsestructure.md) - [Status codes](https://developer.bigpicture.one/reference/statuscodes.md) - [Create box](https://developer.bigpicture.one/reference/addbox.md): Creates a new box as a child of the given box. On-premise availability - BigPicture versions equal to or greater than 8.21.0 - [Delete boxes](https://developer.bigpicture.one/reference/deleteboxes-1.md): Delete boxes and their children. This operation can not be reversed. On-premise availability - BigPicture versions equal to or greater than 8.24.0 - [Duplicate box](https://developer.bigpicture.one/reference/duplicatebox.md): Duplicates a box - create new box based on a data from other box (the given one). On-premise availability - BigPicture versions equal to or greater than 8.21.0 - [Get box hierarchy](https://developer.bigpicture.one/reference/getboxpublicapiresponse.md): Get the hierarchy of all available boxes - i.e. the way they are related to each other. On-premise availability - BigPicture versions equal to or greater than 8.21.0 - [Get box types](https://developer.bigpicture.one/reference/getboxtypes.md): Retrieves all existing box types. On-premise availability - BigPicture versions equal to or greater than 8.21.0 - [Get teams allocated to boxes](https://developer.bigpicture.one/reference/getteamsallocatedtoboxes.md): Retrieves all teams (with their members) that are allocated to any of the given boxes, and information which box has allocated which team. On-premise availability - BigPicture versions equal to or greater than 8.8.0 - [Get global teams](https://developer.bigpicture.one/reference/getglobalteams.md): Retrieves all global teams (with their members) and information which boxes have allocated which global team. On-premise availability - unavailable - [Create global team](https://developer.bigpicture.one/reference/createglobalteam.md): Creates a new global team in the ROOT box. The created team can then be allocated to other boxes. On-premise availability - unavailable - [Update global team](https://developer.bigpicture.one/reference/updateglobalteam.md): Updates an existing global team. On-premise availability - unavailable - [Delete global team](https://developer.bigpicture.one/reference/deleteglobalteam.md): Deletes an existing global team. On-premise availability - unavailable - [Get team members](https://developer.bigpicture.one/reference/getteammembers.md): Retrieves a team with its members and their memberships in a given box. If boxId is not provided, the first accessible box of the team is used. On-premise availability - unavailable - [Update team membership](https://developer.bigpicture.one/reference/updateteammemberships.md): Updates a membership for a given team member in a given box. If newStartDate is null, only availability is updated. On-premise availability - unavailable - [Create team membership](https://developer.bigpicture.one/reference/createteammemberships.md): Adds a membership for a given team member in a given box. When endDate is provided, an additional zero-availability membership starting on the next day is created. On-premise availability - unavailable - [Delete team member](https://developer.bigpicture.one/reference/deleteteammember.md): Removes the given member from the team in a given box together with all of this member's memberships. On-premise availability - unavailable - [Get resource task assignment for the particular Box](https://developer.bigpicture.one/reference/getresourcetaskassignment.md): Retrieves resources assigned to the particular box, i.e. teams, individuals (both with capacities) and tasks with workload. On-premise availability - BigPicture versions equal to or greater than 8.8.0 - [Returns tasks external identifiers](https://developer.bigpicture.one/reference/taskquery.md): Returns tasks external identifiers within the specified date range. Returns only default task types without integrated instances. On-premise availability - unavailable - [Get own scope definition for a box](https://developer.bigpicture.one/reference/getownscopedefinition-1.md): Retrieves scope definition for a given own scope box id. On-premise availability - BigPicture versions equal to or greater than 8.31.0 - [Update own scope definition for a box](https://developer.bigpicture.one/reference/updateownscopedefinition-1.md): Updates scope definition for a given own scope box id. On-premise availability - BigPicture versions equal to or greater than 8.31.0 - [Get sub scope definitions for boxes](https://developer.bigpicture.one/reference/getsubscopedefinitions-1.md): Retrieves scope definitions for provided sub scope box ids that are the descendants of an own scope box. On-premise availability - BigPicture versions equal to or greater than 8.31.0 - [Update sub scope definitions for boxes](https://developer.bigpicture.one/reference/updatesubscopedefinitions-1.md): Updates scope definitions for sub scope boxes provided in a request that are the descendants of an own scope box. On-premise availability - BigPicture versions equal to or greater than 8.31.0 - [Get individual absences](https://developer.bigpicture.one/reference/getresourceabsences_1.md): Retrieves all absences of the given individual. On-premise availability - BigPicture versions equal to or greater than 8.8.0 - [Update already existing absence](https://developer.bigpicture.one/reference/updateresourceabsence_1.md): Updates existing absence of the given individual. On-premise availability - BigPicture versions equal to or greater than 8.8.0 - [Add new absence to individual](https://developer.bigpicture.one/reference/addresourceabsence_1.md): Creates new absence for the individual. On-premise availability - BigPicture versions equal to or greater than 8.8.0 - [Delete individual absence](https://developer.bigpicture.one/reference/deleteresourceabsence_1.md): Deletes an individual absence that starts from the given date. On-premise availability - BigPicture versions equal to or greater than 8.8.0 - [Get individual skills](https://developer.bigpicture.one/reference/getresourceskills-1.md): Retrieves all skills of the given individual. On-premise availability - BigPicture versions equal to or greater than 8.57.0 - [Update already existing skill](https://developer.bigpicture.one/reference/updateresourceskillitem_1-1.md): Updates existing skill of the given individual. On-premise availability - BigPicture versions equal to or greater than 8.57.0 - [Add new skill to individual](https://developer.bigpicture.one/reference/addresourceskillitem_1-1.md): Creates new skill for the individual. On-premise availability - BigPicture versions equal to or greater than 8.57.0 - [Delete individual skill](https://developer.bigpicture.one/reference/deleteresourceskillitem_1-1.md): Deletes an individual skill that starts from the given date. On-premise availability - BigPicture versions equal to or greater than 8.57.0 - [Get all existing skills](https://developer.bigpicture.one/reference/getallskills.md): Retrieves all existing skills. On-premise availability - unavailable - [Create skill](https://developer.bigpicture.one/reference/createskill.md): Creates a new skill. The created skill can then be assigned to individuals or tasks. On-premise availability - unavailable - [Update skill](https://developer.bigpicture.one/reference/updateskill.md): Updates an existing skill. On-premise availability - unavailable - [Delete skill](https://developer.bigpicture.one/reference/deleteskill.md): Deletes an existing skill and removes it from all related objects. On-premise availability - unavailable - [Create box](https://developer.bigpicture.one/reference/addbox-2.md): Creates a new box as a child of the given box. On-premise availability - BigPicture versions equal to or greater than 8.21.0 - [Delete boxes](https://developer.bigpicture.one/reference/deleteboxes-2.md): Delete boxes and their children. This operation can not be reversed. On-premise availability - BigPicture versions equal to or greater than 8.24.0 - [Duplicate box](https://developer.bigpicture.one/reference/duplicatebox-2.md): Duplicates a box - create new box based on a data from other box (the given one). On-premise availability - BigPicture versions equal to or greater than 8.21.0 - [Get box hierarchy](https://developer.bigpicture.one/reference/getboxpublicapiresponse-2.md): Get the hierarchy of all available boxes - i.e. the way they are related to each other. On-premise availability - BigPicture versions equal to or greater than 8.21.0 - [Get box types](https://developer.bigpicture.one/reference/getboxtypes-2.md): Retrieves all existing box types. On-premise availability - BigPicture versions equal to or greater than 8.21.0 - [Get teams allocated to boxes](https://developer.bigpicture.one/reference/getteamsallocatedtoboxes-2.md): Retrieves all teams (with their members) that are allocated to any of the given boxes, and information which box has allocated which team. On-premise availability - BigPicture versions equal to or greater than 8.8.0 - [Get resource task assignment for the particular Box](https://developer.bigpicture.one/reference/getresourcetaskassignment-2.md): Retrieves resources assigned to the particular box, i.e. teams, individuals (both with capacities) and tasks with workload. On-premise availability - BigPicture versions equal to or greater than 8.8.0 - [Get own scope definition for a box](https://developer.bigpicture.one/reference/getownscopedefinition-2.md): Retrieves scope definition for a given own scope box id. On-premise availability - BigPicture versions equal to or greater than 8.31.0 - [Update own scope definition for a box](https://developer.bigpicture.one/reference/updateownscopedefinition-2.md): Updates scope definition for a given own scope box id. On-premise availability - BigPicture versions equal to or greater than 8.31.0 - [Get sub scope definitions for boxes](https://developer.bigpicture.one/reference/getsubscopedefinitions-2.md): Retrieves scope definitions for provided sub scope box ids that are the descendants of an own scope box. On-premise availability - BigPicture versions equal to or greater than 8.31.0 - [Update sub scope definitions for boxes](https://developer.bigpicture.one/reference/updatesubscopedefinitions-2.md): Updates scope definitions for sub scope boxes provided in a request that are the descendants of an own scope box. On-premise availability - BigPicture versions equal to or greater than 8.31.0 - [Get individual absences](https://developer.bigpicture.one/reference/getresourceabsences_1-2.md): Retrieves all absences of the given individual. On-premise availability - BigPicture versions equal to or greater than 8.8.0 - [Update already existing absence](https://developer.bigpicture.one/reference/updateresourceabsence_1-2.md): Updates existing absence of the given individual. On-premise availability - BigPicture versions equal to or greater than 8.8.0 - [Add new absence to individual](https://developer.bigpicture.one/reference/addresourceabsence_1-2.md): Creates new absence for the individual. On-premise availability - BigPicture versions equal to or greater than 8.8.0 - [Delete individual absence](https://developer.bigpicture.one/reference/deleteresourceabsence_1-2.md): Deletes an individual absence that starts from the given date. On-premise availability - BigPicture versions equal to or greater than 8.8.0 - [Get individual skills](https://developer.bigpicture.one/reference/getresourceskills-2.md): Retrieves all skills of the given individual. On-premise availability - BigPicture versions equal to or greater than 8.57.0 - [Update already existing skill](https://developer.bigpicture.one/reference/updateresourceskillitem_1-2.md): Updates existing skill of the given individual. On-premise availability - BigPicture versions equal to or greater than 8.57.0 - [Add new skill to individual](https://developer.bigpicture.one/reference/addresourceskillitem_1-2.md): Creates new skill for the individual. On-premise availability - BigPicture versions equal to or greater than 8.57.0 - [Delete individual skill](https://developer.bigpicture.one/reference/deleteresourceskillitem_1-2.md): Deletes an individual skill that starts from the given date. On-premise availability - BigPicture versions equal to or greater than 8.57.0 - [Get all existing skills](https://developer.bigpicture.one/reference/getallskills-2.md): Retrieves all existing skills. On-premise availability - BigPicture versions equal to or greater than 8.8.0 - [OKR Authentication](https://developer.bigpicture.one/reference/okr-authentication.md) - [Update objective (create update)](https://developer.bigpicture.one/reference/updateobjective.md): ## Base URL for this request Select the server matching your Jira Cloud data residency from the **Servers** drop-down before making requests: - **Europe region:** https://eu.okr-ppm-prod.appfire.com - **Australia region:** https://au.okr-ppm-prod.appfire.com - **Canada region:** https://ca.okr-ppm-prod.appfire.com - **US / Everywhere else:** https://okr-ppm-prod.appfire.com Creates an update for the specified objective. **status** uses the same **displayed** labels as in the app: **NOT STARTED**, **ON TRACK**, **AT RISK**, **OFF TRACK** (action required). **description** is the text stored on that update. The new update becomes the objective's current status (and progress when the objective is manual). - [Update key result (create update)](https://developer.bigpicture.one/reference/updatekeyresult.md): ## Base URL for this request Select the server matching your Jira Cloud data residency from the **Servers** drop-down before making requests: - **Europe region:** https://eu.okr-ppm-prod.appfire.com - **Australia region:** https://au.okr-ppm-prod.appfire.com - **Canada region:** https://ca.okr-ppm-prod.appfire.com - **US / Everywhere else:** https://okr-ppm-prod.appfire.com Creates an update for the specified key result. **status:** displayed values **NOT STARTED**, **ON TRACK**, **AT RISK**, **OFF TRACK**. **newValue:** progress to record on this update — not allowed for **auto** key results (progress from linked work items). For currency units, send a plain number (no currency symbol). **description** appears on the created update. - [Query updates by entity](https://developer.bigpicture.one/reference/fetchupdatesbyentityid.md): ## Base URL for this request Select the server matching your Jira Cloud data residency from the **Servers** drop-down before making requests: - **Europe region:** https://eu.okr-ppm-prod.appfire.com - **Australia region:** https://au.okr-ppm-prod.appfire.com - **Canada region:** https://ca.okr-ppm-prod.appfire.com - **US / Everywhere else:** https://okr-ppm-prod.appfire.com Updates for objectives or key results, **newest first**. Omit **entityId** to return updates across all entities. **Progress:** Prefer **`percentDone`** on objectives and key results for the latest progress — not every change produces an update row. Objective updates always have **value** null (objective progress is derived from key results). For **manual** key results, updates can carry **startValue**, **value**, and **desiredValue** to show progress over time. **Auto** key results: system updates when linked issues change may include progress values; manual text-only updates on auto KRs may omit editable progress on the returned update object. **source:** MANUAL (UI), API (public update API), or AUTO (system/linked issues). **Pagination:** Cursor-based; **nextCursor** in the response means more pages. Absent **nextCursor**, there is no further page. - [Query comments on updates](https://developer.bigpicture.one/reference/fetchcommentsbyupdateids.md): ## Base URL for this request Select the server matching your Jira Cloud data residency from the **Servers** drop-down before making requests: - **Europe region:** https://eu.okr-ppm-prod.appfire.com - **Australia region:** https://au.okr-ppm-prod.appfire.com - **Canada region:** https://ca.okr-ppm-prod.appfire.com - **US / Everywhere else:** https://okr-ppm-prod.appfire.com Paged comments on updates — all updates or filtered by **updateId**. Newest first. **nextCursor** requests the next page; no **nextCursor** when exhausted. - [Query objectives by IDs](https://developer.bigpicture.one/reference/fetchobjectivesbyids.md): ## Base URL for this request Select the server matching your Jira Cloud data residency from the **Servers** drop-down before making requests: - **Europe region:** https://eu.okr-ppm-prod.appfire.com - **Australia region:** https://au.okr-ppm-prod.appfire.com - **Canada region:** https://ca.okr-ppm-prod.appfire.com - **US / Everywhere else:** https://okr-ppm-prod.appfire.com Lists objectives for the given IDs. **expand** controls which related objects are inlined (KEY_RESULTS, TEAMS, PERIODS, LABELS, TYPES, CUSTOM_FIELDS); otherwise you receive IDs only. - [Query objectives by date range](https://developer.bigpicture.one/reference/fetchobjectives.md): ## Base URL for this request Select the server matching your Jira Cloud data residency from the **Servers** drop-down before making requests: - **Europe region:** https://eu.okr-ppm-prod.appfire.com - **Australia region:** https://au.okr-ppm-prod.appfire.com - **Canada region:** https://ca.okr-ppm-prod.appfire.com - **US / Everywhere else:** https://okr-ppm-prod.appfire.com Lists objectives whose **start date** and/or **due date** fall within the query window (epoch milliseconds). Without **expand**, connected entities appear as IDs only. **Permitted expand values:** KEY_RESULTS, TEAMS, PERIODS, LABELS, TYPES, CUSTOM_FIELDS. - [Query key results by IDs](https://developer.bigpicture.one/reference/fetchkeyresultsbyids.md): ## Base URL for this request Select the server matching your Jira Cloud data residency from the **Servers** drop-down before making requests: - **Europe region:** https://eu.okr-ppm-prod.appfire.com - **Australia region:** https://au.okr-ppm-prod.appfire.com - **Canada region:** https://ca.okr-ppm-prod.appfire.com - **US / Everywhere else:** https://okr-ppm-prod.appfire.com Lists key results for the given IDs. **expand:** OBJECTIVES, TEAMS, PERIODS, LABELS, TYPES, CUSTOM_FIELDS. - [Query key results by date range](https://developer.bigpicture.one/reference/fetchkeyresults.md): ## Base URL for this request Select the server matching your Jira Cloud data residency from the **Servers** drop-down before making requests: - **Europe region:** https://eu.okr-ppm-prod.appfire.com - **Australia region:** https://au.okr-ppm-prod.appfire.com - **Canada region:** https://ca.okr-ppm-prod.appfire.com - **US / Everywhere else:** https://okr-ppm-prod.appfire.com Lists key results whose **start** and/or **due date** fall within the window. **Permitted expand values:** OBJECTIVES, TEAMS, PERIODS, LABELS, TYPES, CUSTOM_FIELDS.