Skip to main content
GET
/
workspaces
List Workspaces
curl --request GET \
  --url https://connect.penbox.io/v1/workspaces \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total_count": 123,
    "total_pages": 123,
    "page_size": 123,
    "current_page": 123
  },
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "slug": "<string>",
      "name": "<string>"
    }
  ]
}
Retrieve all Penbox workspaces that the authenticated user has authorized your application to access.

Workspace Slug

The slug is a URL-safe, unique identifier for the workspace. It’s used in API calls to specify which workspace you want to interact with. Slug format:
  • Lowercase letters, numbers, and hyphens
  • No spaces or special characters
  • Unique across all Penbox workspaces
Examples:
  • acme-corp
  • my-company-123
  • law-firm-llp

Multi-Workspace Support

If a user has authorized your application for multiple workspaces, this endpoint returns all of them. The access token grants access to all authorized workspaces.

Authorizations

Authorization
string
header
required

API token (starts with pnbx_). Create at https://app.penbox.io/workspace/settings/api. Include as: Authorization: Bearer {token}

Response

200 - application/json

Successful response

meta
object
data
object[]