Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

List workspaces

GET /api/v1/workspaces

List every workspace the authenticated account can currently access, including each workspace ID, slug, ownership state, and live permissions. Use this before a workspace-scoped operation when the target workspace is not explicit. Never choose a workspace based on recency or list order.

Parameters

This operation has no parameters.

Example

REST requestbash

curl -X GET "https://app.pipeline.help/api/v1/workspaces" \
  -H "Authorization: Bearer $PIPELINE_API_KEY"

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "workspaces": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "isOwner": {
            "type": "boolean"
          },
          "permissions": {
            "type": "object"
          }
        },
        "required": [
          "id",
          "name",
          "slug",
          "isOwner",
          "permissions"
        ]
      }
    }
  },
  "required": [
    "workspaces"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.