# Developer

**URL:** https://community.bluescape.com/c/developer/14.md?page=2

[Latest](https://community.bluescape.com/latest.md) · [Categories](https://community.bluescape.com/categories.md) · [Tags](https://community.bluescape.com/tags.md)

**Page:** 3

---

## [Uploading documents using the Bluescape API](https://community.bluescape.com/t/uploading-documents-using-the-bluescape-api/3659)

<div class="topic-metadata">

**Author:** [@zackyew](https://community.bluescape.com/u/zackyew)\
**Replies:** 2\
**Last updated:** [May 23, 2023, 9:09pm UTC](https://community.bluescape.com/t/uploading-documents-using-the-bluescape-api/3659 "2023-05-23T21:09:56Z")

</div>

Hey folks, May I know what the corresponding fields in the zygote body should be when uploading a pdf to a workspace using the Bluescape API? Currently following the “Upload content into a Canvas for v3” guide, but usin…

---

## [Public API - how do I retrieve list of comments along w/ object the comment relates to?](https://community.bluescape.com/t/public-api-how-do-i-retrieve-list-of-comments-along-w-object-the-comment-relates-to/3645)

<div class="topic-metadata">

**Author:** [@BayAreaCSM](https://community.bluescape.com/u/BayAreaCSM)\
**Replies:** 1\
**Last updated:** [May 19, 2023, 12:34am UTC](https://community.bluescape.com/t/public-api-how-do-i-retrieve-list-of-comments-along-w-object-the-comment-relates-to/3645 "2023-05-19T00:34:48Z")

</div>

Asking for a friend, is there a way to get a list of the comments on a workspace and the element they are linked to through the Bluescape public API?

---

## [Migrating existing v2 API application to v3 OAuth2](https://community.bluescape.com/t/migrating-existing-v2-api-application-to-v3-oauth2/3607)

<div class="topic-metadata">

**Author:** [@kkoechley](https://community.bluescape.com/u/kkoechley)\
**Replies:** 0\
**Last updated:** [May 17, 2023, 3:37pm UTC](https://community.bluescape.com/t/migrating-existing-v2-api-application-to-v3-oauth2/3607 "2023-05-17T15:37:55Z")

</div>

Introduction Bluescape v2 APIs are being decommissioned in 2023. All v2 APIs will lose support, and all requests sent to v2 endpoints will fail once decommissioning is complete. Visit our v3 API documentation to familia…

---

## [May 2023 API Release Notes](https://community.bluescape.com/t/may-2023-api-release-notes/3618)

<div class="topic-metadata">

**Author:** [@kkoechley](https://community.bluescape.com/u/kkoechley)\
**Replies:** 0\
**Last updated:** [May 12, 2023, 12:00am UTC](https://community.bluescape.com/t/may-2023-api-release-notes/3618 "2023-05-12T00:00:04Z")

</div>

Support Note Release 23.05.01 Learn More: April 2023 Release Notes Summary These changes are scheduled to go live on Thursday, April 11 after 9 pm PST for impacted organizations. New API Changes Added a…

---

## [Is there a way to generate thumbnail preview?](https://community.bluescape.com/t/is-there-a-way-to-generate-thumbnail-preview/3577)

<div class="topic-metadata">

**Author:** [@BayAreaCSM](https://community.bluescape.com/u/BayAreaCSM)\
**Replies:** 2\
**Last updated:** [May 3, 2023, 3:40pm UTC](https://community.bluescape.com/t/is-there-a-way-to-generate-thumbnail-preview/3577 "2023-05-03T15:40:07Z")

</div>

Asking for a friend: How would we generate a thumbnail preview of the Bluescape workspace from API?

---

## [April 2023 API Release Notes](https://community.bluescape.com/t/april-2023-api-release-notes/3500)

<div class="topic-metadata">

**Author:** [@kkoechley](https://community.bluescape.com/u/kkoechley)\
**Replies:** 0\
**Last updated:** [April 20, 2023, 1:52am UTC](https://community.bluescape.com/t/april-2023-api-release-notes/3500 "2023-04-20T01:52:07Z")

</div>

Support Note Release 23.04.01 Learn More: April 2023 Release Notes Summary New API Changes Added workspace element rotation APIs with transform.rotateZ, transform.origin.anchor and transform.point Added c…

---

## [March 2023 API Release Notes](https://community.bluescape.com/t/march-2023-api-release-notes/3181)

<div class="topic-metadata">

**Author:** [@kkoechley](https://community.bluescape.com/u/kkoechley)\
**Replies:** 0\
**Last updated:** [March 10, 2023, 2:56am UTC](https://community.bluescape.com/t/march-2023-api-release-notes/3181 "2023-03-10T02:56:03Z")

</div>

Support Note Release 23.03.01 Learn More: March 2023 Release Notes Summary These changes are scheduled to go live on Thursday, March 9 after 9 pm PST for impacted organizations. New API Changes GraphQL o…

---

## [API Reference Pagination v3](https://community.bluescape.com/t/api-reference-pagination-v3/626)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [September 30, 2022, 6:22pm UTC](https://community.bluescape.com/t/api-reference-pagination-v3/626 "2022-09-30T18:22:12Z")

</div>

API Reference Pagination NOTICE: In the current /v3/ GA version, the pagination mechanism has changed. The new cursor-based pagination uses different URL query parameters depending on whether it is the initial request …

---

## [API Reference Versioning v3](https://community.bluescape.com/t/api-reference-versioning-v3/629)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [September 30, 2022, 6:26pm UTC](https://community.bluescape.com/t/api-reference-versioning-v3/629 "2022-09-30T18:26:25Z")

</div>

API Reference Versioning Note: API version v3 is available as GA as part of the 21.10.1 release as of October 08, 2021. Versions Version Path Introduction Release Status 3.0 /v3/ 21.10.1 (October 08, 2021) Cur…

---

## [API Reference Tips and Tricks v3](https://community.bluescape.com/t/api-reference-tips-and-tricks-v3/631)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [September 30, 2022, 6:27pm UTC](https://community.bluescape.com/t/api-reference-tips-and-tricks-v3/631 "2022-09-30T18:27:20Z")

</div>

API Reference Tips and Tricks v3 Manage your Tokens creation with Postman Use Postman to manage the creation and renewal of your Access Tokens: Go to Postman, log in and create a new request: In the new Request, cli…

---

## [API Reference GraphQL v3](https://community.bluescape.com/t/api-reference-graphql-v3/632)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [September 30, 2022, 6:27pm UTC](https://community.bluescape.com/t/api-reference-graphql-v3/632 "2022-09-30T18:27:48Z")

</div>

API Reference GraphQL v3 GraphQL Reference You can access the GraphQL documentation and Schema via the GraphQL Playground page. On the far right side of the screen are the links to the documentation and schema: Wh…

---

## [February 2023 API Release Notes](https://community.bluescape.com/t/february-2023-api-release-notes/3101)

<div class="topic-metadata">

**Author:** [@kkoechley](https://community.bluescape.com/u/kkoechley)\
**Replies:** 0\
**Last updated:** [February 13, 2023, 6:45pm UTC](https://community.bluescape.com/t/february-2023-api-release-notes/3101 "2023-02-13T18:45:49Z")

</div>

Release: 23.02.1 (February 10, 2023) new API changes GraphQL Input field orderedField was added to input object type MemberOrdering GraphQL and REST added unarchiveWorkspace v3 Known issues REST APIs PATCH for Browse…

---

## [January 2023 API Release Notes](https://community.bluescape.com/t/january-2023-api-release-notes/3000)

<div class="topic-metadata">

**Author:** [@kkoechley](https://community.bluescape.com/u/kkoechley)\
**Replies:** 0\
**Last updated:** [January 20, 2023, 1:56am UTC](https://community.bluescape.com/t/january-2023-api-release-notes/3000 "2023-01-20T01:56:51Z")

</div>

Release: 23.01.1 (January 13, 2023) new API changes GraphQL and REST Wall Organization is now optional v3 Known issues REST APIs PATCH for Browser: after modifying height/width, the preview image does not scale or ch…

---

## [API Reference Permissions v3](https://community.bluescape.com/t/api-reference-permissions-v3/627)

<div class="topic-metadata">

**Author:** [@kkoechley](https://community.bluescape.com/u/kkoechley)\
**Replies:** 0\
**Last updated:** [September 30, 2022, 6:25pm UTC](https://community.bluescape.com/t/api-reference-permissions-v3/627 "2022-09-30T18:25:45Z")

</div>

API Reference Permissions Organizations All members of an organization are assigned a role that governs the permissions they have to modify the organization. There are four role types in an organization: Owner Admini…

---

## [December 2022 API Release Notes](https://community.bluescape.com/t/december-2022-api-release-notes/2891)

<div class="topic-metadata">

**Author:** [@kkoechley](https://community.bluescape.com/u/kkoechley)\
**Replies:** 0\
**Last updated:** [December 13, 2022, 10:42pm UTC](https://community.bluescape.com/t/december-2022-api-release-notes/2891 "2022-12-13T22:42:24Z")

</div>

Release: 22.12.1 (December 9, 2022) new API changes GraphQL and REST enum PROVISIONED added to invitationStatus GraphQL and REST added claimScratchWorkspaceByCode which allows turning a scratch workspace into a workspa…

---

## [November 2022 API Release Notes](https://community.bluescape.com/t/november-2022-api-release-notes/2811)

<div class="topic-metadata">

**Author:** [@kkoechley](https://community.bluescape.com/u/kkoechley)\
**Replies:** 0\
**Last updated:** [November 14, 2022, 11:08pm UTC](https://community.bluescape.com/t/november-2022-api-release-notes/2811 "2022-11-14T23:08:46Z")

</div>

Release: 22.11.1 (November 11, 2022) new API changes GraphQL and REST ScratchWorkspace.actorId is now optional GraphQL and REST me.profile.invitationStatus is now an enum GraphQL and REST now allow filtering Users quer…

---

## [October 2022 API Release Notes](https://community.bluescape.com/t/october-2022-api-release-notes/2700)

<div class="topic-metadata">

**Author:** [@kkoechley](https://community.bluescape.com/u/kkoechley)\
**Replies:** 0\
**Last updated:** [October 18, 2022, 11:21pm UTC](https://community.bluescape.com/t/october-2022-api-release-notes/2700 "2022-10-18T23:21:31Z")

</div>

Release: 22.10.1 (October 14, 2022) new API changes GraphQL and Rest added fontSize, fontFamilly, and color to ShapeTextStyle for text block span v3 Known issues REST APIs createShape and updateShape have max width/h…

---

## [API Reference URLs v3](https://community.bluescape.com/t/api-reference-urls-v3/625)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [September 30, 2022, 6:20pm UTC](https://community.bluescape.com/t/api-reference-urls-v3/625 "2022-09-30T18:20:26Z")

</div>

API Reference URLs Below is a list of the URLs needed when developing applications using the Bluescape API. Base URL for REST API Requests: https://api.apps.us.bluescape.com Base URL for GraphQL API Requests: htt…

---

## [API Reference v3](https://community.bluescape.com/t/api-reference-v3/624)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [September 30, 2022, 6:19pm UTC](https://community.bluescape.com/t/api-reference-v3/624 "2022-09-30T18:19:18Z")

</div>

API Reference v3 The Bluescape APIs give you access to a set of secure organization and content management features for use in your environment. You can choose to use RESTful and GraphQL APIs that are organized around …

---

## [September 2022 API Release Notes](https://community.bluescape.com/t/september-2022-api-release-notes/2484)

<div class="topic-metadata">

**Author:** [@kkoechley](https://community.bluescape.com/u/kkoechley)\
**Replies:** 0\
**Last updated:** [September 21, 2022, 5:49pm UTC](https://community.bluescape.com/t/september-2022-api-release-notes/2484 "2022-09-21T17:49:01Z")

</div>

Release: 22.09.1 (September 16, 2022) new API changes GraphQL and Rest added Icon workspace element GraphQL added deleteWorkspace mutation Added webm enum to VideoFormat v3 Known issues REST APIs createShape and upda…

---

## [Embedding Bluescape](https://community.bluescape.com/t/embedding-bluescape/2385)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [September 14, 2022, 7:47pm UTC](https://community.bluescape.com/t/embedding-bluescape/2385 "2022-09-14T19:47:16Z")

</div>

Developer information on embedding existing workspaces and scratch workspaces along with autoLogin information and links to additional developer resources. Introduction Bluescape is an effective collaboration tool tha…

---

## [August 2022 API Release Notes](https://community.bluescape.com/t/august-2022-api-release-notes/2269)

<div class="topic-metadata">

**Author:** [@kkoechley](https://community.bluescape.com/u/kkoechley)\
**Replies:** 0\
**Last updated:** [August 15, 2022, 4:07pm UTC](https://community.bluescape.com/t/august-2022-api-release-notes/2269 "2022-08-15T16:07:19Z")

</div>

Release: 22.08.1 (August 12, 2022) new API GraphQL added orderedField property to improve ordering for ISAM query responses v3 Known issues REST APIs createShape and updateShape mutations have max width/height of 10…

---

## [Attachments APIs for v3](https://community.bluescape.com/t/attachments-apis-for-v3/2139)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [July 26, 2022, 6:50pm UTC](https://community.bluescape.com/t/attachments-apis-for-v3/2139 "2022-07-26T18:50:05Z")

</div>

What are Attachments? Attachments allow the user to pair together two elements so that they act as a single, interactable object. In a Bluescape Workspace, a user has the ability to manually drag an element A on top of …

---

## [Create a Canvas and add a Text Element to it for v3](https://community.bluescape.com/t/create-a-canvas-and-add-a-text-element-to-it-for-v3/2130)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [July 26, 2022, 6:47pm UTC](https://community.bluescape.com/t/create-a-canvas-and-add-a-text-element-to-it-for-v3/2130 "2022-07-26T18:47:22Z")

</div>

Objective: Create a new Canvas in your Workspace and add a Text element to this new Canvas. You will learn how to get the IDs of newly created objects within your Workspace, and how to use them to associate other objects…

---

## [GraphQL vs REST APIs](https://community.bluescape.com/t/graphql-vs-rest-apis/2014)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [July 26, 2022, 6:43pm UTC](https://community.bluescape.com/t/graphql-vs-rest-apis/2014 "2022-07-26T18:43:20Z")

</div>

Here is a comparison of Bluescape \`v3\` REST and GraphQL APIs. You can appreciate the advantages of each implementation, and use this list to help you port queries from REST to GraphQL. Use HTTP POST for GraphQL See the …

---

## [API Reference Known Issues in v3](https://community.bluescape.com/t/api-reference-known-issues-in-v3/1385)

<div class="topic-metadata">

**Author:** [@Vladster](https://community.bluescape.com/u/Vladster)\
**Replies:** 0\
**Last updated:** [August 3, 2022, 6:49pm UTC](https://community.bluescape.com/t/api-reference-known-issues-in-v3/1385 "2022-08-03T18:49:29Z")

</div>

API Known Issues v3 Release: 22.07.1 (July 8, 2022) REST APIs Workspace query and findAvailableArea APIs do not include icons. PATCH for Browser: after modifying height/width, the preview image does not scale or change…

---

## [Get the list of your workspaces for v3](https://community.bluescape.com/t/get-the-list-of-your-workspaces-for-v3/2027)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [July 26, 2022, 6:52pm UTC](https://community.bluescape.com/t/get-the-list-of-your-workspaces-for-v3/2027 "2022-07-26T18:52:01Z")

</div>

Objective: get a list of all Workspaces you can access. You do not need to know your userId to perform this operation. From this list you can retrieve the workspace IDs to use on other APIs that require you to have the W…

---

## [Traits: API for elements traits](https://community.bluescape.com/t/traits-api-for-elements-traits/2138)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [July 26, 2022, 6:49pm UTC](https://community.bluescape.com/t/traits-api-for-elements-traits/2138 "2022-07-26T18:49:48Z")

</div>

NOTICE: The current version of /v3/ GA release does not include REST API support for Traits, they are currently implemented only by GraphQL APIs. Traits will be released with REST API support in a future release for /v3/…

---

## [How to use the findAvailableArea API in v3](https://community.bluescape.com/t/how-to-use-the-findavailablearea-api-in-v3/2135)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [July 26, 2022, 6:49pm UTC](https://community.bluescape.com/t/how-to-use-the-findavailablearea-api-in-v3/2135 "2022-07-26T18:49:20Z")

</div>

Objective: Show how to use the findAvailableArea API in v3. This page contains the implementation details for the use of the findAvailableArea API, for v3 REST APIs and for GraphQL APIs. This functionality is not impl…

---

## [How to find elements in a workspace](https://community.bluescape.com/t/how-to-find-elements-in-a-workspace/2134)

<div class="topic-metadata">

**Author:** [@Tom\_Garrett](https://community.bluescape.com/u/Tom_Garrett)\
**Replies:** 0\
**Last updated:** [July 26, 2022, 6:48pm UTC](https://community.bluescape.com/t/how-to-find-elements-in-a-workspace/2134 "2022-07-26T18:48:58Z")

</div>

Objective: find elements in the workspace that match a specific text string. This is done to get properties of that element, to edit it or to delete it. Also, you may want to find a specific canvas to retrieve its conten…

[Previous page](https://community.bluescape.com/c/developer/14.md?page=1)

[Next page](https://community.bluescape.com/c/developer/14.md?page=3)
