# Hive REST API API

> Hive REST API API on Apizie: 75 endpoints (Get workspaces, Get groups, Create activity feed, Get user, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/analytics:hive/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:hive`
- Category: Analytics
- Status: byok
- Source: https://hive.com
- Page: https://apizie.tech/api/analytics/hive
- OpenAPI: https://apizie.tech/api/analytics/hive/openapi.json

We help teams move faster. Hive's best-in-class project management platform includes all of the tools you need and want - and if not, we will build them for you. With flexible project views and endless customizations,…

## Endpoints

### Get workspaces
`GET https://apizie.tech/v1/analytics:hive/workspace-list-all-workspaces` (byok)

### Get groups
`GET https://apizie.tech/v1/analytics:hive/workspace-get-chat-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | ID of the workspace |

### Create activity feed
`POST https://apizie.tech/v1/analytics:hive/workspacesworkspaceidactivity-feeds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | ID of the workspace |
| body | object | no | JSON request body |

### Get user
`GET https://apizie.tech/v1/analytics:hive/user-get-user-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User ID |

### Update user
`POST https://apizie.tech/v1/analytics:hive/user-update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User ID |
| body | object | no | JSON request body |

### Get users
`GET https://apizie.tech/v1/analytics:hive/user-list-by-email` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| email | string | no | Email address to search by |

### Get workspace users
`GET https://apizie.tech/v1/analytics:hive/user-get-workspace-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | ID of the workspace |

### Invite user
`POST https://apizie.tech/v1/analytics:hive/user-invite-new-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| body | object | no | JSON request body |

### Remove user from workspace
`POST https://apizie.tech/v1/analytics:hive/user-remove-from-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| body | object | no | JSON request body |

### Get workspace external users
`GET https://apizie.tech/v1/analytics:hive/user-list-external-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | ID of the workspace |

### Get action
`GET https://apizie.tech/v1/analytics:hive/action-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | The id of the action |

### Update action
`POST https://apizie.tech/v1/analytics:hive/action-update-action-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | The id of the action |
| body | object | no | JSON request body |

### Delete action
`POST https://apizie.tech/v1/analytics:hive/action-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | The id of the action |

### Get actions
`GET https://apizie.tech/v1/analytics:hive/workspace-get-actions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| projectId | string | no | An optional project ID to get actions from. By default, all actions will be returned regardless of what project they belong to. |
| sortBy | string | no | Sort results by an Action Object field (for example, `sortBy=title asc`) |
| workspaceId | string | yes | ID of the workspace |
| limit | string | no | default = 100; min = 1; max = 100 |
| filters | string | no | Optional fields to filter by. Filters expects a structure like "filters[fieldName]=value". For example, if you wanted to filter to just… |

### Create action
`POST https://apizie.tech/v1/analytics:hive/action-list-actions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get action comments
`GET https://apizie.tech/v1/analytics:hive/action-get-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | The id of the action |
| limit | integer | no | Number of comments |
| sortBy | string | no | You can change to e.g. createdAt asc |

### Create action comment
`POST https://apizie.tech/v1/analytics:hive/action-create-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | The id of the action |
| body | object | no | JSON request body |

### Get action attachments
`GET https://apizie.tech/v1/analytics:hive/action-get-attachments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | The ID of the action. |

### Create action attachment
`POST https://apizie.tech/v1/analytics:hive/action-attach-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | The ID of the action. |
| body | object | no | JSON request body |

### Get attachment by attachment ID
`GET https://apizie.tech/v1/analytics:hive/action-get-attachment-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | The ID of the action. |
| attachmentId | string | yes | The ID of the file attachment. |

### Apply action template
`POST https://apizie.tech/v1/analytics:hive/action-apply-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | Id of the action |
| body | object | no | JSON request body |

### Get action templates
`GET https://apizie.tech/v1/analytics:hive/workspace-get-action-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | ID of the workspace |

### Get action history
`GET https://apizie.tech/v1/analytics:hive/action-get-action-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | The id of the action |

### Create message
`POST https://apizie.tech/v1/analytics:hive/message-create-new-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get project
`GET https://apizie.tech/v1/analytics:hive/project-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| projectId | string | yes | ID of the project to update |

### Update project
`POST https://apizie.tech/v1/analytics:hive/project-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| projectId | string | yes | ID of the project to update |
| body | object | no | JSON request body |

### Delete project
`POST https://apizie.tech/v1/analytics:hive/project-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| projectId | string | yes | ID of the project to update |

### Get projects
`GET https://apizie.tech/v1/analytics:hive/project-list-for-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | ID of the workspace |
| sortBy | string | no | Sort results by an Action Object field (for example, `sortBy=title+asc`) |
| filters | string | no | Optional fields to filter by. Filters expect a structure like "filters[fieldName]=value". For example, if you want to filter to just get… |

### Create project
`POST https://apizie.tech/v1/analytics:hive/project-create-new-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Create project custom field
`POST https://apizie.tech/v1/analytics:hive/project-add-custom-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| projectId | string | yes | ID of the project to add a custom field to |
| body | object | no | JSON request body |

### Update project custom field
`POST https://apizie.tech/v1/analytics:hive/project-update-custom-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| projectId | string | yes | ID of the project to add a custom field to |
| customFieldId | string | yes | ID of the custom field to update |
| body | object | no | JSON request body |

### Set project status
`POST https://apizie.tech/v1/analytics:hive/project-set-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| projectId | string | yes | ID of the project |
| body | object | no | JSON request body |

### Get project statuses
`GET https://apizie.tech/v1/analytics:hive/project-get-statuses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | ID of the workspace |
| first | integer | no | Get first n items |
| last | integer | no | Get last n items |
| before | string | no | document ID to query documents before it |
| after | string | no | document ID to query documents after it |

### Get resource assignment
`GET https://apizie.tech/v1/analytics:hive/resource-assignment-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceAssignmentId | string | yes | ID of the resourceAssignment to update |

### Update resource assignment
`POST https://apizie.tech/v1/analytics:hive/resource-assignment-update-assignment-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceAssignmentId | string | yes | ID of the resourceAssignment |
| body | object | no | JSON request body |

### Delete resource assignment
`POST https://apizie.tech/v1/analytics:hive/resource-assignment-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceAssignmentId | string | yes | ID of the user for the resourcing |

### Get resource assignments
`GET https://apizie.tech/v1/analytics:hive/workspace-list-resource-assignments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | ID of the workspace |
| first | integer | no | Get first n items |
| last | integer | no | Get last n items |
| before | string | no | document ID to query documents before it |
| after | string | no | document ID to query documents after it |

### Create resource assignments
`POST https://apizie.tech/v1/analytics:hive/resource-assignment-create-new-assignment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get custom tags
`GET https://apizie.tech/v1/analytics:hive/workspace-get-custom-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | yes | Type of custom tags you are trying to access. Can be either "user" or "project" |
| workspaceId | string | yes | Workspace ID |

### Create custom tag
`POST https://apizie.tech/v1/analytics:hive/workspace-create-custom-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| body | object | no | JSON request body |

### Get custom tag
`GET https://apizie.tech/v1/analytics:hive/workspace-get-custom-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| customTagId | string | yes | Tag ID |

### Update custom tag
`POST https://apizie.tech/v1/analytics:hive/workspace-update-custom-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| customTagId | string | yes | Custom tag ID |
| body | object | no | JSON request body |

### Delete custom tag
`POST https://apizie.tech/v1/analytics:hive/workspace-delete-custom-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| customTagId | string | yes | Tag ID |

### Get user tags
`GET https://apizie.tech/v1/analytics:hive/user-get-user-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| userId | string | yes | User ID |

### Get user tag
`GET https://apizie.tech/v1/analytics:hive/user-get-user-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| userId | string | yes | ID of the user |
| userTagId | string | yes | ID of the user tag |

### Update user tag
`POST https://apizie.tech/v1/analytics:hive/user-update-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| userId | string | yes | ID of user to update |
| userTagId | string | yes | ID of tag to set on the user |
| body | object | no | JSON request body |

### Get project tags
`GET https://apizie.tech/v1/analytics:hive/project-get-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| projectId | string | yes | Project ID to get tags for |

### Get project tag
`GET https://apizie.tech/v1/analytics:hive/project-get-tag-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| projectId | string | yes | Project ID that you are trying to access project tag for |
| projectTagId | string | yes | ID of the project tag |

### Update project tag
`POST https://apizie.tech/v1/analytics:hive/project-update-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| projectId | string | yes | Project ID to update the tag value on |
| projectTagId | string | yes | Project tag ID |
| body | object | no | JSON request body |

### Get role tags
`GET https://apizie.tech/v1/analytics:hive/workspace-list-role-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |

### Create role tag
`POST https://apizie.tech/v1/analytics:hive/workspace-create-role-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| body | object | no | JSON request body |

### Update role tag
`POST https://apizie.tech/v1/analytics:hive/workspace-update-role-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| roleTagId | string | yes | Role Tag ID |
| body | object | no | JSON request body |

### Delete role tag
`POST https://apizie.tech/v1/analytics:hive/workspace-remove-role-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| roleTagId | string | yes | Role Tag ID |

### Get user role tag
`GET https://apizie.tech/v1/analytics:hive/user-get-user-role-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| userId | string | yes | User ID |

### Update user role tag
`POST https://apizie.tech/v1/analytics:hive/user-update-role-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| userId | string | yes | User ID |
| roleTagId | string | yes | Role tag ID to set on the user |

### Get user setting by userId
`GET https://apizie.tech/v1/analytics:hive/user-get-user-tag-by-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| userId | string | yes | User ID |

### Update user setting
`POST https://apizie.tech/v1/analytics:hive/user-update-user-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| userId | string | yes | User ID |
| body | object | no | JSON request body |

### Get Teams
`GET https://apizie.tech/v1/analytics:hive/team-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |

### Create team
`POST https://apizie.tech/v1/analytics:hive/team-add-new-team` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update Team
`POST https://apizie.tech/v1/analytics:hive/team-update-team-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes |  |
| body | object | no | JSON request body |

### Delete Team
`POST https://apizie.tech/v1/analytics:hive/team-delete-team` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes |  |

### Add members
`POST https://apizie.tech/v1/analytics:hive/team-add-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | Team id |
| body | object | no | JSON request body |

### Remove members
`POST https://apizie.tech/v1/analytics:hive/team-remove-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | Team id |
| body | object | no | JSON request body |

### Get label
`GET https://apizie.tech/v1/analytics:hive/workspace-get-label-role-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| labelId | string | yes | The ID of the Label you want to retrieve |

### Update label
`POST https://apizie.tech/v1/analytics:hive/workspace-update-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| labelId | string | yes | Label ID |
| body | object | no | JSON request body |

### Delete label
`POST https://apizie.tech/v1/analytics:hive/workspace-delete-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| labelId | string | yes | Label ID |

### Get labels
`GET https://apizie.tech/v1/analytics:hive/workspace-get-all-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| limit | integer | no |  |
| skip | integer | no |  |
| sortBy | string | no | Allowed values [name, createdAt] |

### Create label
`POST https://apizie.tech/v1/analytics:hive/workspace-create-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID |
| body | object | no | JSON request body |

### Get custom field
`GET https://apizie.tech/v1/analytics:hive/workspace-get-custom-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customFieldId | string | yes | Id of the custom field |
| workspaceId | string | yes | Workspace ID you wish to see custom fields for |

### Get custom fields
`GET https://apizie.tech/v1/analytics:hive/workspace-get-custom-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID you wish to see custom fields for |

### Create custom field
`POST https://apizie.tech/v1/analytics:hive/workspace-create-custom-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | Workspace ID you wish to see custom fields for |
| body | object | no | JSON request body |

### Get status
`GET https://apizie.tech/v1/analytics:hive/project-get-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| projectStatusId | string | yes | Id of the status |

### Create status
`POST https://apizie.tech/v1/analytics:hive/project-create-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Create webhook
`POST https://apizie.tech/v1/analytics:hive/webhook-create-handler` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Delete webhook
`POST https://apizie.tech/v1/analytics:hive/webhook-remove-handler` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | ID of the Webhook to delete |

## Example
```
curl "https://apizie.tech/v1/analytics:hive/workspace-list-all-workspaces" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Hive REST API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/analytics:hive/workspace-list-all-workspaces with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Hive REST API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Hive REST API itself also needs your own key from app.hive.com.

### Can AI agents use the Hive REST API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key analytics:hive.

### What is the status of the Hive REST API API?
Needs your own provider key (bring your own key)