Skip to main content
GET
List Workspaces
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

How many workspaces you get back

An API key sees only its own workspace. A key is scoped to one workspace, so this endpoint returns that one row — not the workspaces you created with Provision Workspace. Each provisioned workspace gets its own key, returned once at creation, so keep your own list of the ones you create.
With an OAuth app, a user can authorize several workspaces, and this endpoint returns all of them.

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[]