Workspaces

Postman Collection

OpenAPI

Org Workspaces APIs

Operations

POST/v2/orgs/{orgId}/workspaces

POST

Get list of workspaces

A workspace refers to a specific instance of an Atlassian product that is accessed through a unique URL. Whenever a user initiates or adds a new product instance, it results in the creation of a distinct workspace.

This API will:

Return a paginated list of workspaces in a given org
Return more details about an organization's products (including product URL).

Request

Path parameters

orgId

string

Required

Request bodyapplication/json

query

anyOf [AndOperator, NorOperator, FieldOperand, SearchWorkspacesOperand, FeatureFilter, PolicyFilter]

limit

integer

sort

array<SortField>

cursor

string

Responses

Successful operation

application/json

PageDataResponseV2

POST/v2/orgs/{orgId}/workspaces

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/workspaces' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "cursor": "c29tZS1iYXNlLTY0LWVuY29kZWQtY3Vyc29y"
}'

200Response

{
  "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
  }
}