---
updatedAt: 2026-10-01T02:35:55.000Z
agentTools:
  projectIndex: https://developers.hive.com/llms.txt
---

# List workspace actions

Returns cursor-paginated actions accessible to the authenticated user, as edges and pageInfo.

# OpenAPI definition

````json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Hive REST API",
    "version": "2.0.0",
    "description": "The Hive REST API lets you read and change the data in your Hive workspaces from your own tools. Every endpoint lives under `https://app.hive.com/api/v2`. The SCIM 2.0 endpoints at the end of this reference are served from their own base URL, `https://scim.hive.com/v2/{workspaceId}`.\n\n## Authentication\n\nEvery request authenticates with one of:\n\n1. An `api_key` request header.\n2. An `api_key` query parameter.\n3. An `Authorization: Bearer <access_token>` header (OAuth2 access token).\n4. An `access_token` query parameter.\n\nAPI keys are created in the Hive app under **My Settings > API Info**. The acting user is the owner of the key or the token, and every endpoint applies that user's permissions.\n\n```http\nGET /api/v2/workspaces/<workspaceId>/actions\napi_key: <apiKey>\n```\n\nRequests are limited to 1000 per minute per user; beyond that the API answers `429`.\n\n## Responses and errors\n\nSuccessful responses are JSON (`content-type: application/json`). A single-resource endpoint returns the resource, or a message object such as `{ \"message\": \"Action successfully deleted\" }`. A delete answers with a JSON success payload, never an empty body, and keeps Hive's soft-delete semantics where the resource is soft-deleted.\n\nErrors use one JSON shape:\n\n```json\n{ \"error\": 400, \"message\": \"Bad Request\" }\n```\n\n| Status | Meaning |\n| --- | --- |\n| `400` | Validation failure or malformed request |\n| `403` | The user may not access the resource |\n| `404` | The resource does not exist |\n| `429` | Rate limit exceeded |\n| `500` | Unexpected server error |\n\n## Cursor pagination\n\nList endpoints return a page of edges and a `pageInfo` object:\n\n```json\n{\n  \"edges\": [{ \"cursor\": \"<opaqueCursor>\", \"node\": {} }],\n  \"pageInfo\": {\n    \"startCursor\": \"<opaqueCursor>\",\n    \"endCursor\": \"<opaqueCursor>\",\n    \"hasPreviousPage\": false,\n    \"hasNextPage\": true,\n    \"totalCount\": 123\n  }\n}\n```\n\n| Parameter | Meaning |\n| --- | --- |\n| `first` | Page size from the start of the list |\n| `last` | Page size from the end of the list |\n| `after` | Cursor from a previous response, for the next page |\n| `before` | Cursor from a previous response, for the previous page |\n| `total_count` | Set to `true` to include `pageInfo.totalCount` (opt-in because counts can be expensive) |\n\n`first` and `last` are mutually exclusive, must be positive integers, and are capped at 200. Cursors are opaque base64 values derived from the sort field and `_id`; pass them back unchanged.\n\n```text\nGET /api/v2/workspaces/<workspaceId>/actions?first=25\nGET /api/v2/workspaces/<workspaceId>/actions?first=25&after=<endCursor>\nGET /api/v2/workspaces/<workspaceId>/actions?last=25&before=<startCursor>\nGET /api/v2/workspaces/<workspaceId>/actions?first=25&total_count=true\n```\n\n## Sorting\n\n`sortBy=<field> <direction>`, for example `sortBy=createdAt desc` or `sortBy=name asc`. Each endpoint documents its sortable fields. The direction is `asc` or `desc`. Without `sortBy`, an endpoint uses a stable default order, and `_id` breaks ties so pages never skip or repeat items.\n\n## Filtering\n\nFilters use bracketed query parameters:\n\n```text\nfilters[status]=Completed\nfilters[archived]=false\nfilters[customField-<customFieldId>]=value\n```\n\nEach endpoint documents the filters it supports; an unsupported filter answers `400`. Values `true`, `false` and numbers are read as booleans and numbers; other values are JSON when they parse as JSON.\n\nEndpoints that filter by date use the `startDate` and `endDate` query parameters, as ISO 8601 values.\n\n## Creating and updating\n\n- `POST` creates a resource and returns it, or a wrapper with a success message. Bodies are JSON.\n- `PUT` updates a single resource. `PATCH` updates part of a resource, or many at once.\n- Only allowlisted fields are accepted on update.\n\n## Dashboard widget export\n\nChart builder dashboard widgets export through an asynchronous job. The server starts a background export, waits up to about 20 seconds, then returns either a download URL or a poll URL for exports that take longer. Handle both.\n\n**Start an export:** `GET /api/v2/dashboard-widgets/<widgetId>/export`\n\n| Parameter | Default | Values |\n| --- | --- | --- |\n| `type` | `default` | `default`, `detailed` |\n| `format` | `csv` | `csv`, `json` |\n\n`detailed` exports take longer and are more likely to need polling.\n\n```json\n{\n  \"jobId\": \"<jobId>\",\n  \"status\": \"pending | running | completed\",\n  \"pollUrl\": \"/api/v2/dashboard-widget-export-jobs/<jobId>\",\n  \"metadata\": {\n    \"widgetId\": \"<widgetId>\",\n    \"widgetType\": \"<widgetType>\",\n    \"exportType\": \"default | detailed\",\n    \"format\": \"csv | json\"\n  },\n  \"fileUrl\": \"https://...\"\n}\n```\n\n`fileUrl` is present only when the export completed within the wait window; `pollUrl` is always returned. A `400` answers an invalid `type` or `format`, a widget that cannot be exported (`Widget not found`, `Widget type does not support export`, `Dashboard not found for this widget`, `User filter not found`), or an export that failed; a `500` means the export could not be queued.\n\n**Poll a job:** `GET /api/v2/dashboard-widget-export-jobs/<jobId>`. Only the user who started the export can read the job (`403` otherwise, `404` when it does not exist).\n\n```json\n{\n  \"jobId\": \"<jobId>\",\n  \"status\": \"pending | running | completed | failed\",\n  \"metadata\": { \"widgetId\": \"<widgetId>\", \"widgetType\": \"<widgetType>\", \"exportType\": \"default\", \"format\": \"csv\" },\n  \"createdAt\": \"2026-06-08T12:00:00.000Z\",\n  \"fileUrl\": \"https://...\",\n  \"error\": \"Dashboard widget export timed out.\",\n  \"completedAt\": \"2026-06-08T12:05:00.000Z\"\n}\n```\n\n`fileUrl` is present when `status` is `completed`; `error` when it is `failed`; `completedAt` once the job has finished. A job with no progress for about 30 minutes is marked `failed` with `Dashboard widget export timed out.`. Jobs are kept for 72 hours.\n\nRecommended client flow: call the export endpoint; if it returns `fileUrl`, download it and stop; otherwise poll `pollUrl` every 1 to 2 seconds until `status` is `completed` or `failed`."
  },
  "servers": [
    {
      "url": "https://app.hive.com/api/v2"
    }
  ],
  "security": [
    {
      "apiKeyHeader": []
    },
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Actions"
    }
  ],
  "paths": {
    "/workspaces/{workspaceId}/actions": {
      "get": {
        "tags": [
          "Actions"
        ],
        "summary": "List workspace actions",
        "description": "Returns cursor-paginated actions accessible to the authenticated user, as edges and pageInfo.",
        "operationId": "get_workspaces_workspaceId_actions",
        "parameters": [
          {
            "name": "workspaceId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "workspaceId identifier."
          },
          {
            "name": "first",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 200
            },
            "description": "Number of results from the start of the list. Do not combine with last."
          },
          {
            "name": "last",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 200
            },
            "description": "Number of results from the end of the list. Do not combine with first."
          },
          {
            "name": "after",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Cursor returned by a previous response for forward pagination."
          },
          {
            "name": "before",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Cursor returned by a previous response for backward pagination."
          },
          {
            "name": "total_count",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "description": "When present, include totalCount. This route treats any non-empty query-string value, including false, as enabled."
          },
          {
            "name": "sortBy",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Sort expression: field asc|desc. Allowed fields: _id, rank, description, workspace, deleted, deadline, parent, projectId, archived, modifiedAt, createdAt, priorityLevelId, checkedDate."
          },
          {
            "name": "projectId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Optional project ID to restrict actions to one project."
          },
          {
            "name": "startDate",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Optional lower deadline bound. Use date format 'yyyy-mm-dd'."
          },
          {
            "name": "endDate",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Optional upper deadline bound. Use date format 'yyyy-mm-dd'."
          },
          {
            "name": "filters[status]",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter by action status."
          },
          {
            "name": "filters[parent]",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter by parent action ID."
          },
          {
            "name": "filters[archived]",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "description": "Filter by archived state."
          },
          {
            "name": "filters[milestone]",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "description": "Filter by milestone flag."
          },
          {
            "name": "filters[deleted]",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "description": "Filter by deleted state."
          },
          {
            "name": "filters[root]",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter by root action ID."
          },
          {
            "name": "filters[recurringId]",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter by recurring action ID."
          },
          {
            "name": "filters[teamAssignee]",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter by team assignee ID."
          },
          {
            "name": "filters[placeholderAssignees]",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter by placeholder assignee ID."
          },
          {
            "name": "filters[priorityLevelId]",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter by priority level ID."
          },
          {
            "name": "filters[followingUserIds]",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter by following user ID."
          },
          {
            "name": "filters[customField-<customFieldId>]",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter by custom field value. Formula fields are not supported."
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectionResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "api_key"
      },
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "integer"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "PageInfo": {
        "type": "object",
        "properties": {
          "startCursor": {
            "type": "string",
            "nullable": true
          },
          "endCursor": {
            "type": "string",
            "nullable": true
          },
          "hasPreviousPage": {
            "type": "boolean"
          },
          "hasNextPage": {
            "type": "boolean"
          },
          "totalCount": {
            "type": "integer"
          }
        }
      },
      "ConnectionResponse": {
        "type": "object",
        "properties": {
          "edges": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "cursor": {
                  "type": "string"
                },
                "node": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          },
          "pageInfo": {
            "$ref": "#/components/schemas/PageInfo"
          }
        }
      }
    }
  }
}
````