Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Hive

Hive Workspaces API

The Workspaces API from Hive — 15 operation(s) for workspaces.

Documentation Provider Profile APIs.io OpenAPI GitHub

Hive Workspaces API is one of 13 APIs that Hive publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 28 operations across 15 paths. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://app.hive.com/api/v1.

28 operations 15 paths 0 schemas 4 DELETE15 GET2 PATCH4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://app.hive.com/api/v1
Authentication
API Key
Contact
Hive Developers
Resource Areas
1

Authentication & Security 1

Hive Workspaces API declares 1 security scheme for authenticating requests. An API key is passed in the header as api_key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Workspace-scoped API token issued from Hive admin settings.

Paths & Operations 28

Across 15 paths, the API surfaces 28 operations — 4 DELETE, 15 GET, 2 PATCH, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Workspaces 28
GET
/workspaces
List workspaces accessible to the authenticated user
listWorkspaces → 200
GET
/workspaces/{workspaceId}/actions
List actions in a workspace
listWorkspaceActions 1 param → 200
GET
/workspaces/{workspaceId}/actions/search
Search actions in a workspace
searchWorkspaceActions 1 param → 200
GET
/workspaces/{workspaceId}/projects
List projects in a workspace
listWorkspaceProjects 1 param → 200
GET
/workspaces/{workspaceId}/agile_sprints
List agile sprints in a workspace
listSprints 1 param → 200
GET
/workspaces/{workspaceId}/custom_fields
List custom fields
listCustomFields 1 param → 200
POST
/workspaces/{workspaceId}/custom_fields
Create a custom field
createCustomField 1 param → 201
GET
/workspaces/{workspaceId}/custom_fields/{customFieldId}
Get a custom field
getCustomField 2 params → 200
GET
/workspaces/{workspaceId}/labels
List labels
listLabels 1 param → 200
POST
/workspaces/{workspaceId}/labels
Create a label
createLabel 1 param → 201
GET
/workspaces/{workspaceId}/labels/{labelId}
Get a label
getLabel 2 params → 200
PUT
/workspaces/{workspaceId}/labels/{labelId}
Update a label
updateLabel 2 params → 200
DELETE
/workspaces/{workspaceId}/labels/{labelId}
Delete a label
deleteLabel 2 params → 204
GET
/workspaces/{workspaceId}/workflows
List workflows
listWorkflows 1 param → 200
GET
/workspaces/{workspaceId}/groups
List groups
listGroups 1 param → 200
POST
/workspaces/{workspaceId}/groups
Create a group
createGroup 1 param → 201
GET
/workspaces/{workspaceId}/groups/{groupId}
Get a group
getGroup 2 params → 200
PATCH
/workspaces/{workspaceId}/groups/{groupId}
Patch a group
patchGroup 2 params → 200
PUT
/workspaces/{workspaceId}/groups/{groupId}
Update a group
updateGroup 2 params → 200
DELETE
/workspaces/{workspaceId}/groups/{groupId}
Delete a group
deleteGroup 2 params → 204
GET
/workspaces/{workspaceId}/users
List users in a workspace
listWorkspaceUsers 1 param → 200
POST
/workspaces/{workspaceId}/users
Add a user to a workspace
addWorkspaceUser 1 param → 201
DELETE
/workspaces/{workspaceId}/users
Remove a user from a workspace
removeWorkspaceUser 1 param → 204
GET
/workspaces/{workspaceId}/users/{userId}
Get a workspace user
getWorkspaceUser 2 params → 200
PATCH
/workspaces/{workspaceId}/users/{userId}
Patch a workspace user
patchWorkspaceUser 2 params → 200
PUT
/workspaces/{workspaceId}/users/{userId}
Update a workspace user
updateWorkspaceUser 2 params → 200
DELETE
/workspaces/{workspaceId}/users/{userId}
Delete a workspace user
deleteWorkspaceUser 2 params → 204
GET
/workspaces/{workspaceId}/teams
List teams
listTeams 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hive-workspaces-api-openapi.yml Raw ↑

Other APIs Hive publishes across the network.

Hive Public API
AE Profile APIs.io
Hive Actions API
AE Profile APIs.io
Hive Agile Sprints API
AE Profile APIs.io
Hive Dashboard Widgets API
AE Profile APIs.io
Hive Form Submissions API
AE Profile APIs.io
Hive Messages API
AE Profile APIs.io
Hive Projects API
AE Profile APIs.io
Hive Resource Assignments API
AE Profile APIs.io
Hive Teams API
AE Profile APIs.io
Hive Users API
AE Profile APIs.io
Hive Webhooks API
AE Profile APIs.io
Hive Workflows API
AE Profile APIs.io
#Workspaces
← Back to H APIs
API Details
ID
hive:hive-workspaces-api
Base URL
https://app.hive.com/api/v1
Docs
https://developers.hive.com/reference/introduction
Provider
Hive
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network