Skip to main content
Retrieve a list of workspaces in an organization, where each workspace is an Atlassian product instance accessed through a unique URL.
External DocumentationTo learn more, visit the Atlassian Organizations documentation.

​
Basic Parameters

ParameterDescription
CursorA token used to specify a results page. This value can be obtained from the links.next property from a previous response.
LimitThe maximum number of workspaces to return per page. Maximum of 1000 workspaces can be returned.
Organization IDThe unique ID of your organization.

Can be obtained by using the List Organizations action.
Return All PagesAutomatically fetch all resources, page by page.

​
Advanced Parameters

ParameterDescription
QueryA JSON query object to filter workspaces by.

Supports operators like:
* and
* nor
* field
* searchWorkspaces
* features
* policies

For more information about the Query parameter format refer to the Atlassian Organizations documentation
SortA JSON array of sort fields to order the results.

For Example:
[
  {
    “field”:“attributes.name.raw”,
    “order”:“asc”
  }
]

​
Example Output

{
	"data": [
		{
			"id": "<string>",
			"type": "<string>",
			"attributes": {
				"name": "<string>",
				"typeKey": "<string>",
				"type": "<string>",
				"owner": "<string>",
				"status": "online",
				"statusDetails": [
					"<string>"
				],
				"icons": {},
				"avatars": {},
				"labels": [
					"<string>"
				],
				"sandbox": {
					"type": "CHILD"
				},
				"usage": 2154,
				"capacity": 2154,
				"createdAt": "<string>",
				"createdBy": "<string>",
				"updatedAt": "<string>",
				"hostUrl": "<string>",
				"realm": "<string>",
				"regions": [
					"<string>"
				]
			},
			"links": {
				"self": "<string>"
			},
			"relationships": {}
		}
	],
	"links": {
		"self": "<string>",
		"prev": "<string>",
		"next": "<string>"
	},
	"meta": {
		"pageSize": 2154,
		"startIndex": 2154,
		"endIndex": 2154,
		"total": 2154
	}
}

​
Workflow Library Example

List Organization Workspaces with Atlassian Organizations and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop