The Hive Developer Hub

Welcome to the Hive developer hub. You'll find API reference documentation to help you start working with Hive as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    
Suggest Edits

Introduction

 

Welcome to the Hive REST API docs! The reference documentation here is designed for those interested in developing integrations for Hive that are not already inside of the Hive core product. You can use the Hive API to accomplish awesome things for your team, like creating automated messages, kicking off action templates, and much more!

API compatibility

This API will evolve. Future versions of this API may add new endpoints or parameters. Because the API is still in Beta, parameters and endpoint may be subject to change and support is not guaranteed (although we will try our best to maintain backward compatibility).

Clients that want to be future-proof should avoid passing undocumented parameters (as they may cause different behavior in the future), and they should avoid strict checks on the keys of objects found in responses.

SSL only

All requests to the Hive REST API are required to be done over SSL.

Base Endpoint

All requests are to be sent to https://app.hive.com/api/v1 as a prefix.

Feedback + Community Contributions

We're always looking to improve the API + API documentation! If you have suggestions for the docs, please suggest edits on the section you're looking to improve by clicking the "Suggest Edits" button:

"Suggest Edits" button

"Suggest Edits" button

If there's something you'd like to see in the API that does not currently exist, please reach out to the team via live chat by clicking the blue message icon in the bottom right of the screen:

Live chat support

Live chat support

Suggest Edits

API Keys and Auth

 

Getting your API key + User ID

Before you get started, you'll want to generate an API key and grab your User ID. To get those, log into your Hive account, go to the main menu in the top right, and select the "API information". From there, generate a key for use throughout the API.

Location of the API information menu

Location of the API information menu

Minimum Required Parameters

All requests require a user id and API key in the URL query string parameters. The user id parameter is written as "user_id", and the API key parameter is written as "api_key". You can go ahead and test your credentials by hitting the endpoint below with your generated API key and user id:

curl -X GET "https://app.hive.com/api/v1/testcredentials?user_id=ABC123&api_key=APIKEY123"

You should get a User authenticated success message. Great job!

Suggest Edits

Error handling

 

Errors are returned using standard HTTP error code syntax. Any additional info is included in the body of the return call, JSON-formatted. Error codes not listed here are in the API methods listed below.

Any 400 level errors will return an object with a message key describing the error. An example error response might look like:

{ error: 400, message: "User not found" }
Suggest Edits

Workspaces

 

Workspaces are the main container for everything your team does. All Projects, Actions, Messages, Groups, and Users fall under Workspaces.

Below is the data structure of the Workspace object in Hive:

Field
Type
Description

id

String

Unique alphanumeric string id

name

String

Name of the workspace

members

Array

Members of the workspace as an array of User ID Strings

createdAt

ISO Date String

Date + time of Workspace creation

modifiedAt

ISO Date String

Date + time that the Workspace was last modified

createdBy

String/User ID

User ID string of the Workspace creator

modifiedBy

String/User ID

User ID string of the last user to modify fields on the Workspace

Suggest Edits

/workspaces

Get all workspaces that you're is a member of.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://app.hive.com/api/v1/workspaces
var baseUrl = 'https://app.hive.com/api/v1/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
$.get(baseUrl + 'workspaces/' + authQs, function(data) {
  console.log(data);
});
A binary file was returned

You couldn't be authenticated

{
  "id": "1a2b3c4d5e6f7g8h9",
  "name": "Honey Enterprises",
  "members": [
    '1234abc',
    '5678zyc'
  ],
  "createdAt": "2017-05-18T15:26:17.407Z",
  "modifiedAt": "2017-05-19T02:25:06.190Z",
  "createdBy": "1234abcuJzo4k7F9",
  "modifiedBy": "1234abcuJzo4k7F9"
}

 
Suggest Edits

/workspaces/{workspaceId}/groups

Get all chat groups for a given workspace

 

Query Auth

 Authentication is required for this endpoint.
gethttps://app.hive.com/api/v1/workspaces/workspaceId/groups
var baseUrl = 'https://app.hive.com/api/v1/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
$.get(baseUrl + 'workspaces/123ABC567XYZ/groups' + authQs, function(data) {
  console.log(data);
});
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "8MRZ6oYzRMJ4eJYnR",
    "name": "Everyone",
    "members": [
      '1234abcuJzo4k7F9',
      '6789abcuJzo4k7F9'
     ],
    "createdAt": "2017-05-18T15:26:17.407Z",
    "modifiedAt": "2017-05-19T02:25:06.190Z",
    "createdBy": "1234abcuJzo4k7F9",
    "modifiedBy": "1234abcuJzo4k7F9"
  },
  {
    "id": "8S8pMXXJwCeExYWzq",
    "name": "Bee Hive Gossip",
    "members": [
      '1234abcuJzo4k7F9',
      '6789abcuJzo4k7F9'
     ],
    "createdAt": "2017-05-18T15:26:17.407Z",
    "modifiedAt": "2017-05-19T02:25:06.190Z",
    "createdBy": "1234abcuJzo4k7F9",
    "modifiedBy": "1234abcuJzo4k7F9"    
  },
  {
    "id": "8yxNHYsvqYCDFP19J",
    "name": "Maria von Trapp"
    "members": [
      '1234abcuJzo4k7F9',
      '6789abcuJzo4k7F9'
     ],
    "createdAt": "2017-05-18T15:26:17.407Z",
    "modifiedAt": "2017-05-19T02:25:06.190Z",
    "createdBy": "1234abcuJzo4k7F9",
    "modifiedBy": "1234abcuJzo4k7F9"    
  }
]

Path Params

workspaceId
string
required

ID of the workspace

 
Suggest Edits

/workspaces/{workspaceId}/projects

Get all projects for a given workspace that the user has access to

 

Query Auth

 Authentication is required for this endpoint.
gethttps://app.hive.com/api/v1/workspaces/workspaceId/projects
var baseUrl = 'https://app.hive.com/api/v1/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
$.get(baseUrl + 'workspaces/123ABC567XYZ/projects' + authQs, function(data) {
  console.log(data);
});
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "9MRZ6oYzRMJ4eJYnR",
    "name": "Spring Bee Hive Rebuild",
    "sharingType": "everyone",
    "members": [],
    "createdAt": "2017-05-18T15:26:17.407Z",
    "modifiedAt": "2017-05-19T02:25:06.190Z",
    "createdBy": "1234abcuJzo4k7F9",
    "modifiedBy": "1234abcuJzo4k7F9" 
  },
  {
    "id": "9S8pMXXJwCeExYWzq",
    "name": "Sell More Honey Campaign",
    "sharingType": "everyone",
    "members": [],
    "createdAt": "2017-05-18T15:26:17.407Z",
    "modifiedAt": "2017-05-19T02:25:06.190Z",
    "createdBy": "1234abcuJzo4k7F9",
    "modifiedBy": "1234abcuJzo4k7F9"  
  },
  {
    "id": "9yxNHYsvqYCDFP19J",
    "name": "Bee better this year",
    "sharingType": "everyone",
    "members": [],
    "createdAt": "2017-05-18T15:26:17.407Z",
    "modifiedAt": "2017-05-19T02:25:06.190Z",
    "createdBy": "1234abcuJzo4k7F9",
    "modifiedBy": "1234abcuJzo4k7F9"   
  }
]

Path Params

workspaceId
string
required

ID of the workspace

 
Suggest Edits

/workspaces/{workspaceId}/actiontemplates

Get all actions for a given workspace that the user has access to

 

Query Auth

 Authentication is required for this endpoint.
gethttps://app.hive.com/api/v1/workspaces/workspaceId/actiontemplates
var baseUrl = 'https://app.hive.com/api/v1/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
$.get(baseUrl + 'workspaces/123ABC567XYZ/actiontemplates' + authQs, function(data) {
  console.log(data);
});
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "BrhDWFRzJDPMcitEk",
    "name": "Blog Post",
    "createdAt": "2017-05-18T15:26:17.407Z",
    "modifiedAt": "2017-05-19T02:25:06.190Z",
    "createdBy": "1234abcuJzo4k7F9",
    "modifiedBy": "1234abcuJzo4k7F9" 
  },
  {
    "id": "J7ixnuHFP4kmncLun",
    "name": "Product Research",
    "createdAt": "2017-05-18T15:26:17.407Z",
    "modifiedAt": "2017-05-19T02:25:06.190Z",
    "createdBy": "1234abcuJzo4k7F9",
    "modifiedBy": "1234abcuJzo4k7F9"   
  }
]

Path Params

workspaceId
string
required

ID of the workspace

 
Suggest Edits

/workspaces/{workspaceId}/users

Get all actions for a given workspace that the user has access to

 

Query Auth

 Authentication is required for this endpoint.
gethttps://app.hive.com/api/v1/workspaces/workspaceId/users
var baseUrl = 'https://app.hive.com/api/v1/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
$.get(baseUrl + 'workspaces/123ABC567XYZ/users' + authQs, function(data) {
  console.log(data);
});
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "22YK3N5uGpzMdw7fm",
    "profile": {
      "firstName": "Vera",
      "lastName": "Morrisville"
    },
    "fullName": "Vera Morrisville"
  },
  {
    "id": "5oSp4usru9FTsFCuH",
    "profile": {
      "firstName": "Scott",
      "lastName": "Brown"
    },
    "fullName": "Scott Brown"
  },
]

Path Params

workspaceId
string
required

ID of the workspace

 
Suggest Edits

/workspaces/{workspaceId}/activity-feeds

Create an Activity Feed in the specified workspace for a Project or Action

 

Query Auth

 Authentication is required for this endpoint.
posthttps://app.hive.com/api/v1/workspaces/workspaceId/activity-feeds
var baseUrl = 'https://app.hive.com/api/v1/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
$.get(baseUrl + 'workspaces/123ABC567XYZ/activity-feeds' + authQs, function(data) {
  console.log(data);
});
A binary file was returned

You couldn't be authenticated

{
    "id": "abcde123456",
    "workspace": "abcde123456",
    "bucket": "activityFeed",
    "assignedTo": "abcde123456",
    "attachedItemType": "action",
    "attachedItemId": "abcde123456",
    "title": "Comment!",
    "body": "Comment body",
    "createdAt": "1900-01-01T00:00:00.000Z",
    "modifiedAt": "1900-01-01T00:00:00.000Z",
    "createdBy": "server",
    "modifiedBy": "server"
}

Path Params

workspaceId
string
required

ID of the workspace

Body Params

type
string
required

Type determines the icon used ('comment', 'addProject', 'action', 'due', 'assignees', 'subaction', 'ready')

bucket
string

Bucket for the ActivityFeed

assignedTo
string
required

UserId to receive this ActivityFeed

attachedItemType
string
required

'action' or 'project'

attachedItemId
string
required

Id of the related item

title
string

Title

body
string
required
 
 

Workspaces are the main container for everything your team does. All Projects, Actions, Messages, Groups, and Users fall under Workspaces.

Actions in Hive represent pieces of work for you and your team to do (similar to Tasks or To-dos like in other apps, but much more powerful and team-oriented!). Actions always belong to a single Workspace and can belong to either one or no Projects. Lastly, part of what makes Actions in Hive so powerful is that they can be infinitely nested within each other. Actions that are nested are called sub Actions and are denoted by their "parent" field having an ID.

Below is the data structure of the Action object in Hive:

Field
Type
Description

id

String

Unique alphanumeric string id

title

String

Title of the action

workspace

String/Workspace ID

ID of the Workspace that the Action belongs to

assignees

Array

Array of User ID strings. Array with value 'none' represents unassigned

projectId

String/Project ID

ID of the Project (if any) that the Action belongs to

description

String

User input description of the action

customFields

Array of objects
[{ label: '', value: '' }]

Action custom fields

createdAt

ISO Date String

Date + time of Action creation

modifiedAt

ISO Date String

Date + time that the Action was last modified

createdBy

String/User ID

User ID string of the Action creator

modifiedBy

String/User ID

User ID string of the last user to modify fields on the Action

Suggest Edits

/actions/create

Get all actions for a given workspace that the user has access to

 

Query Auth

 Authentication is required for this endpoint.
posthttps://app.hive.com/api/v1/actions/create
var baseUrl = 'https://app.hive.com/api/v1/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
var action = {
  workspace: '1234567abcd',
  title: 'New product research',
  assigned_to: '1234567abcde',
  when: 'today'
};
$.post(baseUrl + 'actions/create' + authQs, action, function(data) {
  console.log(data);
});
A binary file was returned

You couldn't be authenticated

{
  "id": "qFR6a524nFARukmvF",
  "workspace": "12345aZjDQZndHqs",
  "title": "This is my action",
  "description": "I just created a new action",
  "assignees": [
    "12345gfuJzo4k7F9"
  ],
  "deadline": null,
  "modifiedAt": "2018-01-23T21:41:40.289Z",
  "customFields": [],
  "createdAt": "2018-01-23T21:41:40.295Z",
  "createdBy": "12345gfuJzo4k7F9",
  "modifiedBy": "12345gfuJzo4k7F9"
}

Body Params

workspace
string

ID of the workspace

title
string

Title of the action

description
string

Description of the action

assignees
array of strings

User Ids of action assignees; if value isn't passed the action will be assigned to the user Id of the request

projectId
string

Assign action to a specific project

deadline
string

Date string to set the deadline (date format: yyyy/mm/dd)

processId
string

Pass action template id to apply an action template

customFields
array of objects

Add custom fields to the action: Each object must contain label (string) and value (string)

Label
Value
 
Suggest Edits

/actions/{actionId}

Update the status of a given action

 

Query Auth

 Authentication is required for this endpoint.
puthttps://app.hive.com/api/v1/actions/actionId
var actionId = '1a2b3c4d5e6f7g8h9';
var baseUrl = 'https://app.hive.com/api/v1/actions/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
var url = `${baseUrl}${actionId}${authQs}`;

$.ajax(url, {
  method: 'PUT',
  contentType: "application/json",
  data: JSON.stringify({
    status: 'In Progress',
  	update_children: false,
  }),
  success: function(response) {
    // response.action = Updated action
  }
});
A binary file was returned

You couldn't be authenticated

{
    "message": "Action status successfully updated",
    "action": {
        "id": "1a2b3c4d5e6f7g8h9",
        "title": "Action Title",
        "workspace": "fd8s97f9sd87f89s",
        "assignees": [
            "4k5l36jklgb32hj"
        ],
        "projectId": "g6fd9a87v98ds78",
        "customFields": [],
        "createdAt": "2018-07-27T17:10:49.687Z",
        "modifiedAt": "2018-07-30T18:12:10.411Z",
        "createdBy": "fds879a7fd8s9a",
        "modifiedBy": "fds879a7fd8s9a",
        "status": "In Progress"
    }
}

Path Params

actionId
string
required

The id of the action

Body Params

status
string

The new status of the action

update_children
boolean

True if this action's children should also have their statuses updated

 
 

Messages are sent from given Users (denoted by Message.sender) to a given chat Group (denoted by Message.containerId). All new Messages created from the API are done on behalf of the user whose API key + User ID is used in your POST.

If you'd like the Message to appear with a custom sender display name/custom sender image, use the "Message.senderFirstname" and "Message.senderPicture" to override the User's default for a given message.

Below is the data structure of the Message object in Hive:

Field
Type
Description

id

String

Unique alphanumeric string id

containerId

String/Group ID

ID of the chat Group that the Message belongs to

body

String

Body of the Message

sender

String/User ID

ID of the User who sent the Message

senderFirstname

String

Optional name of the sender, can be used to override the display name of the sender for a given Message

senderPicture

String/URL

Optional URL, can be used to override the display image over the sender for a given Message

workspace

String/Workspace ID

ID of the Workspace that the Message belongs to

createdAt

ISO Date String

Date + time of Message creation

modifiedAt

ISO Date String

Date + time that the Message was last modified

createdBy

String/User ID

User ID string of the Message creator

modifiedBy

String/User ID

User ID string of the last user to modify fields on the Message

color

String

Optional background color for the message. Options are yellow, purple, green, red, gray

Suggest Edits

/messages/create

Get all actions for a given workspace that the user has access to

 

Query Auth

 Authentication is required for this endpoint.
posthttps://app.hive.com/api/v1/messages/create
var baseUrl = 'https://app.hive.com/api/v1/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
var message = {
  workspace: '1234567abcd',
  body: 'Hi! this message was sent from the API.',
  senderName: 'Automated Messages',
  senderPicture: 'https://cdn2.iconfinder.com/data/icons/botcons/100/android-bot-round-ears-eyes-virus-brown-256.png',
  containerId: 'Group12345'
};
$.post(baseUrl + 'messages/create' + authQs, message, function(data) {
  console.log(data);
});
A binary file was returned

You couldn't be authenticated

{
  "id": "2bK58icvKeJSzvupB",
  "sender": "12345gfuJzo4k7F9",
  "workspace": "12345naZjDQZndHqs",
  "containerId": "12345ZTJqWY2QK2B",
  "body": "This is a new message",
  "senderFirstName": "My Bot",
  "color": "yellow",
  "createdBy": "12345gfuJzo4k7F9",
  "modifiedBy": "12345xgfuJzo4k7F9",
  "createdAt": "2018-01-23T22:14:24.862Z",
  "modifiedAt": "2018-01-23T22:14:24.862Z"
}

Body Params

workspace
string

ID of the workspace

body
string

Body of the message

senderFirstName
string

The name of the sender

senderPicture
string

URL of the sender picture

containerId
string

Group the message will be created in

color
string

Optional background color for the message. Options are yellow, purple, green, red, gray

 
 

Projects are optional containers for organizing Actions in your Workspace. Projects can be limited to subsets of Users so that any Actions in them are kept private to just Project members.

Below is the data structure of the Project object in Hive:

Field
Type
Description

id

String

Unique alphanumeric string id

name

String

Name of the Project

description

String

Text representing an optional project description

endDate

ISO Date String

End date of the Project

sharingType

String

Can be one of three types:

  1. "everyone" - Project is accessible by everyone in the workspace
  2. "custom" - Project is limited to a subset of users in the workspace. If set to "custom", the "members" field shows which users have access
  3. "me" - Project is limited to just the user who has access

members

Array

Members of the project (if sharingType is set to "custom") as an array of User ID Strings

projectCustomFields

Array

Array of project-level custom fields

projectCustomFields.$._id

String

Unique alphanumeric string id for a projectCustomField entry

projectCustomFields.$.type

String

Custom field value type. Currently just limited/defaulted to "text"

projectCustomFields.$.label

String

Label for the custom field

projectCustomFields.$.value

String

Stored value of the custom field

createdAt

ISO Date String

Date + time of Project creation

modifiedAt

ISO Date String

Date + time that the Project was last modified

createdBy

String/User ID

User ID string of the Project creator

modifiedBy

String/User ID

User ID string of the last user to modify fields on the Project

color

String

Hex code for project color

Suggest Edits

/projects/{projectId}

Get a project by id

 

Query Auth

 Authentication is required for this endpoint.
gethttps://app.hive.com/api/v1/projects/projectId
var baseUrl = 'https://app.hive.com/api/v1/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
$.ajax(baseUrl + 'projects/123ABC567XYZ' + authQs, {
  method: 'GET',
  success: function(response) {
    // response.project = Project
  }
});
A binary file was returned

You couldn't be authenticated

{
  project:
  {
    "id": "123ABC567XYZ",
    "name": "New project name",
    "description": "A new project description right here!",
    "endDate": "2019-04-01T00:00:00.000Z",
    "sharingType": "everyone",
    "members": [],
    "projectCustomFields": [
      {
        "_id": "1234abcuJzo4k7E1",
        "type": "text",
        "label": "Budget",
        "value": "$1000000"
      }
    ],
    "color": "#F2F2F2",
    "createdAt": "2017-05-18T15:26:17.407Z",
    "modifiedAt": "2017-05-19T02:25:06.190Z",
    "createdBy": "1234abcuJzo4k7F9",
    "modifiedBy": "1234abcuJzo4k7F9"
  }
}

Path Params

projectId
string
required

ID of the project to update

 
Suggest Edits

/projects

Create a new project

 

Query Auth

 Authentication is required for this endpoint.
posthttps://app.hive.com/api/v1/projects
var baseUrl = 'https://app.hive.com/api/v1/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
$.ajax(baseUrl + 'projects' + authQs, {
  method: 'POST',
  contentType: "application/json",
  data: JSON.stringify({
    name: 'Mobile app development',
    workspace: 'workspace_id_123',
    description: 'A project for tracking our shiny new mobile app.',
    endDate: new Date('4/1/2019'),
    sharingType: 'custom',
    members: ['123ABC456XYZ'],
    teams: ['123ABC987XYZ'],
    projectCustomFields: [
      { label: 'Project lead', value: 'George Boole' },
      { label: 'Design link', value: 'https://invision.com/designs' },
    ],
    color: "#F2F2F2",
  }),
  success: function(response) {
    // response.project = Newly created project
  }
});
A binary file was returned

You couldn't be authenticated

{
  "message": "Project was created successfully",
  "project": {
    "id": "123ABC567XYZ",
    "name": "Mobile app development",
    "workspace": "workspace_id_123",
    "description": "A project for tracking our shiny new mobile app.",
    "sharingType": "custom",
    "members": ["123ABC456XYZ"],
    "projectCustomFields": [
      {
        "_id": "1234abcuJzo4k7E2",
        "type": "text",
        "label": "Project lead",
        "value": "George Boole"
      },
      {
        "_id": "1234abcuJzo4k7E3",
        "type": "text",
        "label": "Design link",
        "value": "https://invision.com/designs"
      },
    ],
    "color": "#F2F2F2",
    "createdAt": "2017-05-18T15:26:17.407Z",
    "modifiedAt": "2017-05-19T02:25:06.190Z",
    "createdBy": "1234abcuJzo4k7F9",
    "modifiedBy": "1234abcuJzo4k7F9",
  }
}

Body Params

workspace
string
required

ID of the workspace for the project to be created in

name
string
required

Name of the project

description
string

Project description

endDate
date

End date of the Project

sharingType
string

Sharing type of the project (one of "everyone", "custom" or "me")

members
array of strings

Array of User IDs to set as members of the project. Only relevant if "sharingType" is set to "custom"

teams
array of strings

Array of Team IDs to set as members of the project. Only relevant if "sharingType" is set to "custom"

projectCustomFields
array of objects

Custom fields stored on the project-level

_id
type
label
value
color
string

Optional hex code for project color

 
Suggest Edits

/projects/{projectId}

Update a project by id

 

Query Auth

 Authentication is required for this endpoint.
puthttps://app.hive.com/api/v1/projects/projectId
var baseUrl = 'https://app.hive.com/api/v1/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
$.ajax(baseUrl + 'projects/123ABC567XYZ' + authQs, {
  method: 'PUT',
  contentType: "application/json",
  data: JSON.stringify({
    name: 'New project name',
    description: 'A new project description right here!',
    endDate: new Date('4/1/2019'),
    color: '#F2F2F2',
  }),
  success: function(response) {
    // response.project = Updated project
  }
});
A binary file was returned

You couldn't be authenticated

{
  project:
  {
    "id": "123ABC567XYZ",
    "name": "New project name",
    "description": "A new project description right here!",
		"endDate": "2019-04-01T00:00:00.000Z",
    "sharingType": "everyone",
    "members": [],
    "projectCustomFields": [
      {
        "_id": "1234abcuJzo4k7E1",
        "type": "text",
        "label": "Budget",
        "value": "$1000000"
      }
    ],
    "createdAt": "2017-05-18T15:26:17.407Z",
    "modifiedAt": "2017-05-19T02:25:06.190Z",
    "createdBy": "1234abcuJzo4k7F9",
    "modifiedBy": "1234abcuJzo4k7F9",
    "color": "#F2F2F2"
  }
}

Path Params

projectId
string
required

ID of the project to update

Body Params

name
string

Project name

description
string

Project description

endDate
date

End date of the Project. Pass false or null value to unset

color
string

Optional hex code for project color

 
Suggest Edits

/projects/{projectId}/project-custom-field

Creates a new custom field for a project

 

Query Auth

 Authentication is required for this endpoint.
posthttps://app.hive.com/api/v1/projects/projectId/project-custom-field
var baseUrl = 'https://app.hive.com/api/v1/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
var projectId = '123ABC567XYZ';
$.ajax(baseUrl + 'projects/' + projectId + '/project-custom-field' + authQs, {
  method: 'POST',
  contentType: "application/json",
  data: JSON.stringify({
    label: 'Budget',
    value: '$1000000',
  }),
  success: function(response) {
    // response.project = Updated project
  }
});
A binary file was returned

You couldn't be authenticated

{
  project:
  {
    "id": "123ABC567XYZ",
    "name": "Mobile app development",
    "description": "A project for tracking our shiny new mobile app.",
    "sharingType": "everyone",
    "members": [],
    "projectCustomFields": [
      {
        "_id": "1234abcuJzo4k7E2",
        "type": "text",
        "label": "Budget",
        "value": "$1000000"
      },
    ],
    "color": "#F2F2F2",
    "createdAt": "2017-05-18T15:26:17.407Z",
    "modifiedAt": "2017-05-19T02:25:06.190Z",
    "createdBy": "1234abcuJzo4k7F9",
    "modifiedBy": "1234abcuJzo4k7F9"
  }
}

Path Params

projectId
string
required

ID of the project to add a custom field to

Body Params

label
string
required

Label for the custom field

value
string
required

Value of the custom field

hidden
boolean

If true, the value will be hidden in the UI but accessible via API

 
Suggest Edits

/projects/{projectId}/project-custom-field/{customFieldId}

Updates an existing custom field for a project

 

Query Auth

 Authentication is required for this endpoint.
puthttps://app.hive.com/api/v1/projects/projectId/project-custom-field/customFieldId
var baseUrl = 'https://app.hive.com/api/v1/';
var authQs = '?api_key=' + apiKey + '&user_id=' + userId;
var projectId = '123ABC567XYZ';
var customFieldId = '1234abcuJzo4k7E2'
$.ajax(baseUrl + 'projects/' + projectId + '/project-custom-field/' + customFieldId + authQs, {
  method: 'PUT',
  contentType: "application/json",
  data: JSON.stringify({
    label: 'Budget',
    value: '$5000000',
  }),
  success: function(response) {
    // response.project = Updated project
  }
});
A binary file was returned

You couldn't be authenticated

{
  project:
  {
    "id": "123ABC567XYZ",
    "name": "Mobile app development",
    "description": "A project for tracking our shiny new mobile app.",
    "sharingType": "everyone",
    "members": [],
    "projectCustomFields": [
      {
        "_id": "1234abcuJzo4k7E2",
        "type": "text",
        "label": "Budget",
        "value": "$5000000"
      },
    ],
    "color": "#F2F2F2",
    "createdAt": "2017-05-18T15:26:17.407Z",
    "modifiedAt": "2017-05-19T02:25:06.190Z",
    "createdBy": "1234abcuJzo4k7F9",
    "modifiedBy": "1234abcuJzo4k7F9"
  }
}

Path Params

projectId
string
required

ID of the project to add a custom field to

customFieldId
string
required

ID of the custom field to update

Body Params

label
string

Label for the custom field

value
string

Value of the custom field