{"info":{"_postman_id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","name":"Hub Planner API","description":"

Hub Planner is a cloud-based Resource Management platform that was founded with the mission of enabling companies of all sizes to schedule their teams effectively. Our goal is simple: make it easy for project managers to schedule their team and for team members to understand what they should work on and report time against.

Hub Planners APIs belong to the Representational State Transfer (REST) category. They allow you to perform 'RESTful' operations such as reading, modifying, adding or deleting data programmatically from your Hub Planner account.

The easiest way to get started with the API is grab your API Key from your settings page and use a program like Postman to verify the calls you would like to make.

Overview

You need a valid API Key to send requests to the API endpoints. You can get your key from settings -> API. (You must be logged in as the owner)
The API has an access rate limit applied to it.
The Hub Planner API will only respond to secured communication done over HTTPS. HTTP requests will be sent a 301 redirect to corresponding HTTPS resources.
Response to every request is sent in JSON format. In case the API request results in an error, it is represented by an \"error\": {} key in the JSON response.
The request method (verb) determines the nature of action you intend to perform. A request made using the GET method implies that you want to fetch something from Hub Planner, and POST implies you want to save something new to Hub Planner.
The API calls will respond with appropriate HTTP status codes for all requests. A 200 OK indicates all went well, while 4XX or 5XX response codes indicate an error from the requesting client or our API servers respectively.
Individual resources in your Hub Planner Account are accessible using their unique id's (_id).

Authentication

The documentation will use this variables which are unique to your account and can be referenced here.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
{{API_URL}}	https://api.hubplanner.com/v1
{{API_KEY}}	API Key you get from your Hub Planner account page and used in the Authorization header.

You must supply an Authorization header with the token for all requests with the value being the {{API_KEY}}. In the header set the Content-Type to application/json.

API Calls

Hub Planners APIs are plain JSON over HTTP and use the following HTTP verbs:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Command	Purpose
POST	Create an object.
GET	Fetch one or more objects.
PUT	Update an object.
DELETE	Remove an object.
PATCH	Update a property in the object.

Rate Limit

For security reasons we have a daily limit of 6000 API calls and burst limits of 50 per 5 seconds on every account. Please be careful to avoid these limits as otherwise you will get an error response from the API.

Note:

Please follow the best practices to stay under the rate limit.
If you need more than the default limit, please contact us.
Even invalid requests will count towards the rate limit.

Pagination

Most of the endpoints can be paginated using url parameters limit and page. For Bookings and Time Entries passing no limit returns 20 results by default which can then be paginated, while other end points for Project and Resources will return all results.

The max limit you can set is 1000.

If you pass a limit of 0 or a limit of > 1000, you will get a Bad Request 400 response from the server.

The example call to make use of pagination looks like this:

GET /project?page=0&limit=20

Which will paginate endpoint with 20 results per page. Pages start numbering with 0. If you want to get all results you should loop through pages until you reach page with less than requested amount of elements(in this example less than 20).

The endpoints that can be paginated in most areas are GET /areaName and POST /areaName/search.

Sorting

Most of the endpoints can be sorted ascending or descending based on some of the properties. Documentation for each area you have access to lists sortable fields in the property table. Results can be sorted for GET /areaName and POST /areaName/search requests.

To sort the data add sort parameter to the url, followed by field you want to sort by. Prefix the property with minus sign(-) to sort in descending order. For example:

GET /projectGroup?sort=-name

Will sort the project groups in descending order based on their names.

You can chain multiple sort arguments to create more advanced sort results. For example:

GET /projectGroup?sort=-groupType&sort=name

Will first sort project groups by their group types in descending order, then sort each group type alphabetically by name. Sample response(with unnecessary properties ommited):

[\n   {\n      \"name\":\"Eric's Projects\",\n      \"groupType\":\"USER\",\n   },\n   {\n      \"name\":\"Greg's Projects\",\n      \"groupType\":\"USER\",\n   },\n   {\n      \"name\":\"Rudolf's Projects\",\n      \"groupType\":\"USER\",\n   },\n   {\n      \"name\":\"Active Projects\",\n      \"groupType\":\"SYSTEM\",\n   },\n   {\n      \"name\":\"Archived Projects\",\n      \"groupType\":\"SYSTEM\",\n   },\n   {\n      \"name\":\"Events\",\n      \"groupType\":\"SYSTEM\",\n   },\n   {\n      \"name\":\"Floating projects\",\n      \"groupType\":\"SYSTEM\",\n   },\n   {\n      \"name\":\"Pending projects\",\n      \"groupType\":\"SYSTEM\",\n   },\n   {\n      \"name\":\"Planned projects\",\n      \"groupType\":\"SYSTEM\",\n   }\n]\n\n

It's suggested that you use sort argument along with pagination.

Best Practices

Whenever possible, please queue API calls at your end. This ensures that you can buffer calls on your end to avoid hitting the rate limit and retry API calls when you hit the rate limit after the retry-after time.
Cache non-volatile data on your end whenever it is feasible. For e.g. the mapping between resource name and ID is extremely unlikely to change. Hence, by caching it on the client side, you will be able to avoid API calls.
As soon as you recognise that a rate limit increase will be required in the future, contact us. This will make it possible for us to ensure that we are prepared to increase the limit as and when as it is needed.
Avoid making API calls directly from a mobile app, rather send the request to your servers and make the API calls from there. This ensures that in the event of an API endpoint being modified, you will be able to make and deploy the change to your server rather than updating your app and forcing your users to the latest version.
When retrieving a list of objects, avoid making calls referencing page numbers over 500 (deep pagination). These are performance intensive calls and you may suffer from extremely long response times.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"API Calls","slug":"api-calls"},{"content":"Rate Limit","slug":"rate-limit"},{"content":"Pagination","slug":"pagination"},{"content":"Sorting","slug":"sorting"},{"content":"Best Practices","slug":"best-practices"}],"owner":"2584556","collectionId":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","publishedId":"TVt2e4mM","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-01-04T11:12:50.000Z"},"item":[{"name":"Resources","item":[{"name":"Get all resources","id":"c4dbe5c6-3146-4dad-bed5-167e5bf0c7b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","type":"text","value":"{{API_KEY}}","description":"

API Key for account

\n"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{API_URL}}/resource","description":"

Get all resources loaded into the account. Will return an array of resource objects.

The following is a description of the properties in the response.

Property	Type	Description	Required	Sortable
_id	string	id of the Resource	NO	NO
email	string	Resource Email (Unique)	NO	YES
metadata	string	Custom Field (255 Characters)	NO	YES
createdDate	string	Resource Creation Date	NO	YES
updatedDate	string	Resource Updated Date	NO	YES
note	string	Resource Notes	NO	NO
firstName	string	Resource First Name	YES	YES
lastName	string	Resource Last Name	NO	YES
status	string	Resource Status	NO	YES
role	string	Resource Role	NO	YES
links	object	Resource Links	NO	NO
billing	object	Resource Billing Options	NO, deprecated, use `resourceRates` instead	NO
useCustomAvailability	boolean	Using Default Availability	NO	NO
customFields	object array	Custom Fields, read Custom Fields section to see how to set them	NO	NO
resourceRates	object	Reference to billing rates for the resource	NO	NO

If you only want a certain status of resource such as STATUS_ACTIVE.

{\"status\" : \"STATUS_ACTIVE\" }\n

will return all resources which are NOT STATUS_ACTIVE

{\"status\" : {\"$nin\": \"STATUS_ACTIVE\" } }\n

will return all resources which are STATUS_ACTIVE and STATUS_ARCHIVED

{\"status\" : {\"$in\": [\"STATUS_ACTIVE\", \"STATUS_ARCHIVED\"] } }\n

Search Parameters

Use paramters to narrow you search. For example use $nin for not included, and use $in for included.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Parameters
$nin	not included
$in	included

Searchable Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Parameters	Description
_id	$nin, $in	resource id
metadata	$nin, $in	custom meta data field
firstName	$nin, $in	resource first name
lastName	$nin, $in	resource last name
status	$nin, $in	resource status
role	$nin, $in	resource role
email	$nin, $in	resource email

Pass a specific {{RESOURCE_ID}} if you would like to query just 1 resource.

API Key you get from your Hub Planner account page.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description	Default	Required	Sortable
_id	string	id of the Resource	-	NO	NO
email	string	Resource Email (Unique)	-	NO	YES
metadata	string	You can add your own data here (255 Characters)	-	NO	YES
createdDate	string	Resource Creation Date	-	NO	YES
updatedDate	string	Resource Updated Date	-	NO	YES
note	string	Resource Notes	-	NO	NO
firstName	string	Resource First Name	-	YES	YES
lastName	string	Resource Last Name	-	NO	YES
status	string	Resource Status	Active	NO	YES
role	string	Resource Role	Team	NO	YES
links	object	Resource Links	-	NO	NO
billing	object	Resource Billing Options	-	NO, deprecated, use `resourceRates` instead	NO
useCustomAvailability	boolean	Using Default Availability	System	NO	NO
customAvailabilities	object	Set custom availabilities if useCustomAvailability is true	System	NO
customFields	object array	Resource custom fields array. Custom Fields Extension must be installed.	-	NO	NO
isProjectManager	boolean	Flags the resource as a project manager. PM Extension must be installed.	-	NO	NO
resourceRates	object	Set the rates of a resource. Billing Rates Extension must be installed.	-	NO	NO
tags	object array	Set the tags on the resource.	-	NO	NO
calendarIds	object array	set the public holiday calendar for a resource.	-	NO	NO

Create Multiple Resources

To create multiple resources, use the same endpoint and pass all objects in an array []

  [\n   {\n      \"firstName\":\"Sam\",\n      \"lastName\":\"Nolan\",\n      \"email\":\"sam.nolan@hubplanner.com\"\n   },\n   {\n      \"firstName\":\"Rich\",\n      \"lastName\":\"Curran\",\n      \"email\":\"rich.curran@hubplanner.com\"\n   }\n]\n

","urlObject":{"path":["resource"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0b58677b-03ab-4340-af7e-33993408b2be","name":"Create a Resource","originalRequest":{"method":"POST","header":[{"description":"API Key you get from your Hub Planner account page. ","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Taslima\",\n \"lastName\": \"Lees\"\n}"},"url":"{{API_URL}}/resource"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Jan 2021 11:08:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"521"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609840182"},{"key":"X-RateLimit-Remaining","value":"5984"},{"key":"ETag","value":"W/\"209-63PZRy18rYzUV95h4VsY+D+DCts\""}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5ff2f739c56f300b0f742b74\",\n \"email\": \"\",\n \"metadata\": \"\",\n \"createdDate\": \"2021-01-04T11:08:41.645Z\",\n \"updatedDate\": null,\n \"note\": \"\",\n \"firstName\": \"Taslima\",\n \"lastName\": \"Lees\",\n \"status\": \"STATUS_ACTIVE\",\n \"role\": \"ROLE_TEAM\",\n \"isProjectManager\": false,\n \"links\": {\n \"iconLink5\": \"\",\n \"link5\": \"\",\n \"iconLink4\": \"\",\n \"link4\": \"\",\n \"iconLink3\": \"\",\n \"link3\": \"\",\n \"iconLink2\": \"\",\n \"link2\": \"\",\n \"iconLink1\": \"\",\n \"link1\": \"\"\n },\n \"billing\": {\n \"useDefault\": true,\n \"rate\": 0\n },\n \"resourceRates\": {\n \"internal\": [],\n \"external\": []\n },\n \"tags\": [],\n \"customFields\": [],\n \"useCustomAvailability\": false\n}"},{"id":"11dd1d30-7f90-455b-8f23-83d3ab0ee72c","name":"Create a Resource with custom fields","originalRequest":{"method":"POST","header":[{"description":"API Key you get from your Hub Planner account page. ","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Taslima\",\n \"lastName\": \"Lees\",\n \"customFields\": [\n {\n \"templateId\": \"5ff2f3680fcbae0aff739602\",\n \"templateType\": \"text\",\n \"value\": \"The Lord of the Rings\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}/resource"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Jan 2021 12:33:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"668"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609840182"},{"key":"X-RateLimit-Remaining","value":"5970"},{"key":"ETag","value":"W/\"29c-mQ7Msgni1pKN1pyRbIkPkMfWySk\""}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5ff30b240fcbae0aff73f324\",\n \"email\": \"\",\n \"metadata\": \"\",\n \"createdDate\": \"2021-01-04T12:33:40.208Z\",\n \"updatedDate\": null,\n \"note\": \"\",\n \"firstName\": \"Taslima\",\n \"lastName\": \"Lees\",\n \"status\": \"STATUS_ACTIVE\",\n \"role\": \"ROLE_TEAM\",\n \"isProjectManager\": false,\n \"links\": {\n \"iconLink5\": \"\",\n \"link5\": \"\",\n \"iconLink4\": \"\",\n \"link4\": \"\",\n \"iconLink3\": \"\",\n \"link3\": \"\",\n \"iconLink2\": \"\",\n \"link2\": \"\",\n \"iconLink1\": \"\",\n \"link1\": \"\"\n },\n \"billing\": {\n \"useDefault\": true,\n \"rate\": 0\n },\n \"resourceRates\": {\n \"internal\": [],\n \"external\": []\n },\n \"tags\": [],\n \"customFields\": [\n {\n \"templateId\": \"5ff2f3680fcbae0aff739602\",\n \"_id\": \"5ff30b240fcbae0aff73f327\",\n \"templateType\": \"text\",\n \"templateLabel\": \"\",\n \"value\": \"The Lord of the Rings\"\n }\n ],\n \"useCustomAvailability\": false\n}"},{"id":"de2b166d-7ff4-41d9-b1b6-925c09057430","name":"Create multiple Resources","originalRequest":{"method":"POST","header":[{"description":"API Key you get from your Hub Planner account page. ","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"firstName\": \"Britney\",\n \"lastName\": \"Wallis\"\n },\n {\n \"firstName\": \"Coby\",\n \"lastName\": \"Shah\"\n }\n]"},"url":"{{API_URL}}/resource"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Jan 2021 11:10:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1044"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609840182"},{"key":"X-RateLimit-Remaining","value":"5983"},{"key":"ETag","value":"W/\"414-2HQoPXWEARH5l5ZFwrGp5vOm4DU\""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"5ff2f797dbbc040b2584f9d9\",\n \"email\": \"\",\n \"metadata\": \"\",\n \"createdDate\": \"2021-01-04T11:10:15.734Z\",\n \"updatedDate\": null,\n \"note\": \"\",\n \"firstName\": \"Britney\",\n \"lastName\": \"Wallis\",\n \"status\": \"STATUS_ACTIVE\",\n \"role\": \"ROLE_TEAM\",\n \"isProjectManager\": false,\n \"links\": {\n \"iconLink5\": \"\",\n \"link5\": \"\",\n \"iconLink4\": \"\",\n \"link4\": \"\",\n \"iconLink3\": \"\",\n \"link3\": \"\",\n \"iconLink2\": \"\",\n \"link2\": \"\",\n \"iconLink1\": \"\",\n \"link1\": \"\"\n },\n \"billing\": {\n \"useDefault\": true,\n \"rate\": 0\n },\n \"resourceRates\": {\n \"internal\": [],\n \"external\": []\n },\n \"tags\": [],\n \"customFields\": [],\n \"useCustomAvailability\": false\n },\n {\n \"_id\": \"5ff2f797dbbc040b2584f9df\",\n \"email\": \"\",\n \"metadata\": \"\",\n \"createdDate\": \"2021-01-04T11:10:15.822Z\",\n \"updatedDate\": null,\n \"note\": \"\",\n \"firstName\": \"Coby\",\n \"lastName\": \"Shah\",\n \"status\": \"STATUS_ACTIVE\",\n \"role\": \"ROLE_TEAM\",\n \"isProjectManager\": false,\n \"links\": {\n \"iconLink5\": \"\",\n \"link5\": \"\",\n \"iconLink4\": \"\",\n \"link4\": \"\",\n \"iconLink3\": \"\",\n \"link3\": \"\",\n \"iconLink2\": \"\",\n \"link2\": \"\",\n \"iconLink1\": \"\",\n \"link1\": \"\"\n },\n \"billing\": {\n \"useDefault\": true,\n \"rate\": 0\n },\n \"resourceRates\": {\n \"internal\": [],\n \"external\": []\n },\n \"tags\": [],\n \"customFields\": [],\n \"useCustomAvailability\": false\n }\n]"}],"_postman_id":"a35ff771-3589-46e5-9086-0cdd8ab6d344"},{"name":"Update a resource","id":"8b6efb6c-0e47-4bd1-aa48-aae6420c521b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"Good worker\"\n}"},"url":"{{API_URL}}/resource/{{RESOURCE_ID}}","description":"

You can easily update a resource by passing the _id of the resource and the property you would like to update.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","name":"Hub Planner API","type":"collection"}},"urlObject":{"path":["resource","{{RESOURCE_ID}}"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"24a2c6f7-ad18-4850-b917-f768d7896bb6","name":"Update a resource - custom availability","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"useCustomAvailability\" : true,\n \"customAvailabilities\": {\n \"_id\": \"5ff2e2703413f40b136719e0\",\n \"weekDays\": {\n \"sunday\": {\n \"minutes\": 0,\n \"workDay\": false\n },\n \"saturday\": {\n \"minutes\": 0,\n \"workDay\": false\n },\n \"friday\": {\n \"minutes\": 120,\n \"workDay\": true\n },\n \"thursday\": {\n \"minutes\": 120,\n \"workDay\": true\n },\n \"wednesday\": {\n \"minutes\": 30,\n \"workDay\": true\n },\n \"tuesday\": {\n \"minutes\": 120,\n \"workDay\": true\n },\n \"monday\": {\n \"minutes\": 240,\n \"workDay\": true\n }\n }\n }\n}"},"url":"{{API_URL}}/resource/{{RESOURCE_ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Jan 2021 12:41:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1098"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609840182"},{"key":"X-RateLimit-Remaining","value":"5965"},{"key":"ETag","value":"W/\"44a-CZ9s6H1jLQApryEAkCkl0YXb78o\""},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5ff2e2703413f40b136719de\",\n \"email\": \"\",\n \"metadata\": \"\",\n \"createdDate\": \"2021-01-04T09:40:00.201Z\",\n \"updatedDate\": \"2021-01-04T12:41:56.146Z\",\n \"note\": \"Very good worker\",\n \"firstName\": \"Nela\",\n \"lastName\": \"Graves\",\n \"status\": \"STATUS_ACTIVE\",\n \"role\": \"ROLE_TEAM\",\n \"isProjectManager\": false,\n \"links\": {\n \"iconLink5\": \"fa-link\",\n \"link5\": \"\",\n \"iconLink4\": \"fa-link\",\n \"link4\": \"\",\n \"iconLink3\": \"fa-link\",\n \"link3\": \"\",\n \"iconLink2\": \"fa-link\",\n \"link2\": \"\",\n \"iconLink1\": \"fa-link\",\n \"link1\": \"\"\n },\n \"billing\": {\n \"useDefault\": true,\n \"rate\": 0\n },\n \"resourceRates\": {\n \"internal\": [],\n \"external\": []\n },\n \"tags\": [],\n \"customFields\": [\n {\n \"templateId\": \"5ff2f3680fcbae0aff739602\",\n \"_id\": \"5ff30c633413f40b1367c84a\",\n \"templateType\": \"TEXT\",\n \"templateLabel\": \"Favourite book\",\n \"value\": \"The Hobbit\"\n }\n ],\n \"useCustomAvailability\": true,\n \"customAvailabilities\": {\n \"_id\": \"5ff2e2703413f40b136719e0\",\n \"weekDays\": {\n \"sunday\": {\n \"minutes\": 0,\n \"workDay\": false\n },\n \"saturday\": {\n \"minutes\": 0,\n \"workDay\": false\n },\n \"friday\": {\n \"minutes\": 120,\n \"workDay\": true\n },\n \"thursday\": {\n \"minutes\": 120,\n \"workDay\": true\n },\n \"wednesday\": {\n \"minutes\": 30,\n \"workDay\": true\n },\n \"tuesday\": {\n \"minutes\": 120,\n \"workDay\": true\n },\n \"monday\": {\n \"minutes\": 240,\n \"workDay\": true\n }\n }\n }\n}"},{"id":"16cd3d9b-67a9-4fc2-9b3f-953d16c2cc0f","name":"Update a resource - custom availability intervals","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"useCustomAvailability\" : true,\n \"customAvailabilities\": {\n \"_id\": \"5ff2e2703413f40b136719e0\",\n \"weekDays\": {\n \"sunday\": {\n \"minutes\": 0,\n \"workDay\": false\n },\n \"saturday\": {\n \"minutes\": 0,\n \"workDay\": false\n },\n \"friday\": {\n \"minutes\": 120,\n \"workDay\": true,\n \"intervals\": [{\n \"start\": 600,\n \"end\": 720,\n }]\n },\n \"thursday\": {\n \"minutes\": 240,\n \"workDay\": true,\n \"intervals\": [{\n \"start\": 540,\n \"end\": 720\n }, {\n \"start\": 780,\n \"end\": 840\n }]\n },\n \"wednesday\": {\n \"minutes\": 30,\n \"workDay\": true\n },\n \"tuesday\": {\n \"minutes\": 120,\n \"workDay\": true\n },\n \"monday\": {\n \"minutes\": 240,\n \"workDay\": true\n }\n }\n }\n}"},"url":"{{API_URL}}/resource/{{RESOURCE_ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Jan 2021 12:41:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1098"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609840182"},{"key":"X-RateLimit-Remaining","value":"5965"},{"key":"ETag","value":"W/\"44a-CZ9s6H1jLQApryEAkCkl0YXb78o\""},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5ff2e2703413f40b136719de\",\n \"email\": \"\",\n \"metadata\": \"\",\n \"createdDate\": \"2021-01-04T09:40:00.201Z\",\n \"updatedDate\": \"2021-01-04T12:41:56.146Z\",\n \"note\": \"Very good worker\",\n \"firstName\": \"Nela\",\n \"lastName\": \"Graves\",\n \"status\": \"STATUS_ACTIVE\",\n \"role\": \"ROLE_TEAM\",\n \"isProjectManager\": false,\n \"links\": {\n \"iconLink5\": \"fa-link\",\n \"link5\": \"\",\n \"iconLink4\": \"fa-link\",\n \"link4\": \"\",\n \"iconLink3\": \"fa-link\",\n \"link3\": \"\",\n \"iconLink2\": \"fa-link\",\n \"link2\": \"\",\n \"iconLink1\": \"fa-link\",\n \"link1\": \"\"\n },\n \"billing\": {\n \"useDefault\": true,\n \"rate\": 0\n },\n \"resourceRates\": {\n \"internal\": [],\n \"external\": []\n },\n \"tags\": [],\n \"customFields\": [\n {\n \"templateId\": \"5ff2f3680fcbae0aff739602\",\n \"_id\": \"5ff30c633413f40b1367c84a\",\n \"templateType\": \"TEXT\",\n \"templateLabel\": \"Favourite book\",\n \"value\": \"The Hobbit\"\n }\n ],\n \"useCustomAvailability\": true,\n \"customAvailabilities\": {\n \"_id\": \"5ff2e2703413f40b136719e0\",\n \"weekDays\": {\n \"sunday\": {\n \"minutes\": 0,\n \"workDay\": false\n },\n \"saturday\": {\n \"minutes\": 0,\n \"workDay\": false\n },\n \"friday\": {\n \"minutes\": 120,\n \"workDay\": true,\n \"intervals\": [\n {\n \"start\": 600,\n \"end\": 720,\n \"_id\": \"65f1ac50dfe7e41023b18dcf\"\n }\n ],\n \"legacy\": false,\n \"legacyMinutes\": 120\n },\n \"thursday\": {\n \"minutes\": 120,\n \"workDay\": true,\n \"intervals\": [\n {\n \"start\": 540,\n \"end\": 720,\n \"_id\": \"65f1ac50dfe7e41023b18dcc\"\n },\n {\n \"start\": 780,\n \"end\": 840,\n \"_id\": \"65f1ac50dfe7e41023b18dcd\"\n }\n ],\n \"legacy\": false,\n \"legacyMinutes\": 240\n },\n \"wednesday\": {\n \"minutes\": 30,\n \"workDay\": true\n },\n \"tuesday\": {\n \"minutes\": 120,\n \"workDay\": true\n },\n \"monday\": {\n \"minutes\": 240,\n \"workDay\": true\n }\n }\n }\n}"},{"id":"40f89565-fb4e-49c4-96cb-6ff3ed05d302","name":"Update a resource","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"Good worker\"\n}"},"url":"{{API_URL}}/resource/{{RESOURCE_ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Jan 2021 12:18:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"588"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609840182"},{"key":"X-RateLimit-Remaining","value":"5978"},{"key":"ETag","value":"W/\"24c-DSupyCGkRfuP8n8TflcWv3jDvQ8\""},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5ff2e2703413f40b136719de\",\n \"email\": \"\",\n \"metadata\": \"\",\n \"createdDate\": \"2021-01-04T09:40:00.201Z\",\n \"updatedDate\": \"2021-01-04T12:18:40.196Z\",\n \"note\": \"Good worker\",\n \"firstName\": \"Nela\",\n \"lastName\": \"Graves\",\n \"status\": \"STATUS_ACTIVE\",\n \"role\": \"ROLE_TEAM\",\n \"isProjectManager\": false,\n \"links\": {\n \"iconLink5\": \"fa-link\",\n \"link5\": \"\",\n \"iconLink4\": \"fa-link\",\n \"link4\": \"\",\n \"iconLink3\": \"fa-link\",\n \"link3\": \"\",\n \"iconLink2\": \"fa-link\",\n \"link2\": \"\",\n \"iconLink1\": \"fa-link\",\n \"link1\": \"\"\n },\n \"billing\": {\n \"useDefault\": true,\n \"rate\": 0\n },\n \"resourceRates\": {\n \"internal\": [],\n \"external\": []\n },\n \"tags\": [],\n \"customFields\": [],\n \"useCustomAvailability\": false\n}"},{"id":"5a9b1616-f8af-4f8b-bfee-0411fa2dcf4b","name":"Update a resource - custom fields","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customFields\" : [\n \t{\n \"templateId\": \"5ff2f3680fcbae0aff739602\",\n \"templateType\": \"text\",\n\t\t\t\"value\": \"The Hobbit\"\n \t}\n ]\n}"},"url":"{{API_URL}}/resource/{{RESOURCE_ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Jan 2021 12:38:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"743"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609840182"},{"key":"X-RateLimit-Remaining","value":"5967"},{"key":"ETag","value":"W/\"2e7-FWCgStdiT1HYmtwvBGPhUsHFweI\""},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5ff2e2703413f40b136719de\",\n \"email\": \"\",\n \"metadata\": \"\",\n \"createdDate\": \"2021-01-04T09:40:00.201Z\",\n \"updatedDate\": \"2021-01-04T12:38:59.820Z\",\n \"note\": \"Very good worker\",\n \"firstName\": \"Nela\",\n \"lastName\": \"Graves\",\n \"status\": \"STATUS_ACTIVE\",\n \"role\": \"ROLE_TEAM\",\n \"isProjectManager\": false,\n \"links\": {\n \"iconLink5\": \"fa-link\",\n \"link5\": \"\",\n \"iconLink4\": \"fa-link\",\n \"link4\": \"\",\n \"iconLink3\": \"fa-link\",\n \"link3\": \"\",\n \"iconLink2\": \"fa-link\",\n \"link2\": \"\",\n \"iconLink1\": \"fa-link\",\n \"link1\": \"\"\n },\n \"billing\": {\n \"useDefault\": true,\n \"rate\": 0\n },\n \"resourceRates\": {\n \"internal\": [],\n \"external\": []\n },\n \"tags\": [],\n \"customFields\": [\n {\n \"templateId\": \"5ff2f3680fcbae0aff739602\",\n \"_id\": \"5ff30c633413f40b1367c84a\",\n \"templateType\": \"TEXT\",\n \"templateLabel\": \"Favourite book\",\n \"value\": \"The Hobbit\"\n }\n ],\n \"useCustomAvailability\": false\n}"}],"_postman_id":"8b6efb6c-0e47-4bd1-aa48-aae6420c521b"},{"name":"Update Multiple Resources","id":"53ca9c97-6b16-462c-ba0c-890a3918c79a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"

API Key you get from your Hub Planner account page.

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"_id\": \"5de7987edcf2ed0ffafb4f3b\",\n \"customFields\": [\n { \n \"templateId\": \"5d8b863dff4c63350ac86790\",\n \"templateType\": \"SELECT\",\n \"choices\": [\n {\n \"value\": \"Contractor\",\n \"choiceId\": \"5d8b865cff4c63350ac8686d\"\n }\n ]\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}/resource","description":"

You just need to pass in multiple objects in the array [] to bulk update multiple resources.

Use the following command to delete a specific resource by id.

To delete multiple resources provide the array of ids in the request body.

This operation works as adding to set, meaning that it preserves already existing tags and appends only new ones added in request body.

\n\n\n\n\n\n\n\n\n\n\n\n\n

The Resources API will allow you to control all aspects of creating, reading, updating and deleting resources in your account.

\n","_postman_id":"bc03b8ed-7e44-4180-a7d2-24007e3e8236","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","name":"Hub Planner API","type":"collection"}}},{"name":"Projects","item":[{"name":"Projects","id":"c2622598-8730-45eb-b93f-584540bc4221","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

API Key you get from your Hub Planner account page.

Get all projects from API.

You can use pagination and/or sorting (see example).

The following is a description of the properties in the response.

Property	Type	Description	Required	Sortable
_id	string	id of the project	NO	NO
name	string	Project name	YES	YES
links	object	Project Links	NO	NO
note	string	Project Notes	NO	NO
createdDate	string	Project Creation Date	NO	YES
updatedDate	string	Project Updated Date	NO	YES
timeEntryEnabled	boolean	If time entry is enabled	NO	NO
timeEntryLocked	boolean	If time entry is locked	NO	NO
timeEntryApproval	boolean	If time entry approval is set	NO	NO
resourceRates	object	Reference to resource billing rates	NO, deprecated, use `projectRate` instead	NO
includeBookedTimeReports	boolean	If to include booked time reports	NO	NO
includeBookedTimeGrid	boolean	If to include booked time grid	NO	NO
projectManagers	string array	Project managers of project	NO	NO
resources	string array	Resources in project	NO	NO
budget	object	An object containing budget properites.	NO, deprecated, use `projectRate` instead	NO
companyBillingRateId	string	Id of selected billing rate for project	NO, deprecated, use `projectRate` instead	NO
budgetHours	number	Amount of hours budgeted for this project. 0 means the budget in hours is disabled for this project.	NO	YES
budgetCashAmount	number	Amount of money budgeted for this project, given in currency selected in `budgetCurrency`. 0 means that cash budget is disabled in this project.	NO	YES
budgetCurrency	number	Currency of money budgeted for this project	NO	YES
useStatusColor	boolean	If using the default status color or not	NO	NO
status	string	Project Status (STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_PENDING, STATUS_PLANNED, STATUS_FLOATING)	NO, defaults to Active	YES
useProjectDuration	boolean	Display Project Start and End Display Dates	NO	NO
start	string	('YYYY-MM-DD') Project Start Display Date	Only if `useProjectDuration` is set to true	YES
end	string	('YYYY-MM-DD') Project End Display Date	Only if `useProjectDuration` is set to true	YES
backgroundColor	string	Project Color	NO	NO
projectCode	string	Project Code (Unique)	NO	NO
metadata	string	Custom Field (255 Characters)	NO	YES
customFields	object array	Custom Fields, read Custom Fields section to see how to set them	NO, but if you use them check Custom Fields section to see how to use them	NO
timeEntryNoteRequired	boolean	Require Note on Time Entries	NO	NO
projectRate	object	Reference to billing rates in project	NO	NO

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","name":"Hub Planner API","type":"collection"}},"urlObject":{"path":["project"],"host":["{{API_URL}}"],"query":[{"key":"sort","value":"-createdDate"},{"key":"limit","value":"1"},{"key":"page","value":"0"}],"variable":[]}},"response":[{"id":"33270b58-9f61-48d8-9b05-ca330e1db258","name":"Get Projects - using sort and pagination","originalRequest":{"method":"GET","header":[{"description":"API Key you get from your Hub Planner account page. ","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{API_URL}}/project?sort=-createdDate&limit=1&page=0","host":["{{API_URL}}"],"path":["project"],"query":[{"key":"sort","value":"-createdDate"},{"key":"limit","value":"1"},{"key":"page","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Jan 2021 11:47:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1266"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609933304"},{"key":"X-RateLimit-Remaining","value":"5996"},{"key":"ETag","value":"W/\"4f2-C4BLR/etz2Ku80cTeX+eCmxjSpQ\""},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"5ff451c74e6a950b5cdeb4e5\",\n \"name\": \"Testing\",\n \"links\": {\n \"iconLink5\": \"fa-link\",\n \"link5\": \"\",\n \"iconLink4\": \"fa-link\",\n \"link4\": \"\",\n \"iconLink3\": \"fa-link\",\n \"link3\": \"\",\n \"iconLink2\": \"fa-link\",\n \"link2\": \"\",\n \"iconLink1\": \"fa-link\",\n \"link1\": \"\"\n },\n \"note\": \"\",\n \"createdDate\": \"2021-01-05T11:47:19.816Z\",\n \"updatedDate\": \"2021-01-05T11:47:19.816Z\",\n \"timeEntryEnabled\": true,\n \"timeEntryLocked\": false,\n \"timeEntryApproval\": false,\n \"projectCode\": \"test\",\n \"tags\": [],\n \"timeEntryNoteRequired\": false,\n \"workDays\": [\n false,\n true,\n true,\n true,\n true,\n true,\n false\n ],\n \"useProjectDays\": false,\n \"budget\": {\n \"hasBudget\": false,\n \"projectHours\": {\n \"active\": false,\n \"hours\": 0\n },\n \"cashAmount\": {\n \"active\": false,\n \"amount\": 0,\n \"currency\": \"USD\",\n \"billingRate\": {\n \"useDefault\": false,\n \"rate\": 0,\n \"id\": null\n }\n }\n },\n \"budgetHours\": 0,\n \"budgetCashAmount\": 0,\n \"budgetCurrency\": \"USD\",\n \"companyBillingRateId\": null,\n \"resourceRates\": [],\n \"useStatusColor\": true,\n \"status\": \"STATUS_ACTIVE\",\n \"useProjectDuration\": false,\n \"start\": null,\n \"end\": null,\n \"includeBookedTimeReports\": true,\n \"includeBookedTimeGrid\": true,\n \"private\": true,\n \"projectManagers\": [],\n \"resources\": [],\n \"backgroundColor\": \"#81A489\",\n \"metadata\": \"\",\n \"customFields\": [],\n \"projectRate\": {\n \"internal\": {\n \"customRates\": [],\n \"defaultRateId\": null\n },\n \"external\": {\n \"customRates\": [],\n \"defaultRateId\": null\n }\n },\n \"customers\": [],\n \"defaultCategory\": \"5ff2e26c3413f40b1367194e\"\n }\n]"},{"id":"56c73b1f-800f-4408-b81e-d8941bd5af88","name":"Get all Projects","originalRequest":{"method":"GET","header":[{"description":"API Key you get from your Hub Planner account page. ","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{API_URL}}/project"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Jan 2021 07:56:20 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1375"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609840182"},{"key":"X-RateLimit-Remaining","value":"5942"},{"key":"ETag","value":"W/\"55f-4ZzWU2R4gzSCO+Rp7wykMTYyLTw\""},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"5ff2e2703413f40b13671a16\",\n \"name\": \"Development\",\n \"links\": {\n \"link1\": \"\",\n \"iconLink1\": \"fa-link\",\n \"link2\": \"\",\n \"iconLink2\": \"fa-link\",\n \"link3\": \"\",\n \"iconLink3\": \"fa-link\",\n \"link4\": \"\",\n \"iconLink4\": \"fa-link\",\n \"link5\": \"\",\n \"iconLink5\": \"fa-link\"\n },\n \"note\": \"\",\n \"createdDate\": \"2021-01-04T09:40:00.879Z\",\n \"updatedDate\": \"2021-01-05T07:56:15.056Z\",\n \"timeEntryEnabled\": true,\n \"timeEntryLocked\": false,\n \"timeEntryApproval\": true,\n \"projectCode\": \"dev\",\n \"tags\": [],\n \"timeEntryNoteRequired\": false,\n \"workDays\": [\n false,\n true,\n true,\n true,\n true,\n true,\n false\n ],\n \"useProjectDays\": false,\n \"budget\": {\n \"hasBudget\": false,\n \"projectHours\": {\n \"active\": false,\n \"hours\": 0\n },\n \"cashAmount\": {\n \"active\": false,\n \"amount\": 0,\n \"currency\": \"USD\",\n \"billingRate\": {\n \"useDefault\": false,\n \"rate\": 0,\n \"id\": null\n }\n }\n },\n \"budgetHours\": 0,\n \"budgetCashAmount\": 0,\n \"budgetCurrency\": \"USD\",\n \"companyBillingRateId\": null,\n \"resourceRates\": [],\n \"useStatusColor\": true,\n \"status\": \"STATUS_ACTIVE\",\n \"useProjectDuration\": false,\n \"start\": null,\n \"end\": null,\n \"includeBookedTimeReports\": true,\n \"includeBookedTimeGrid\": true,\n \"private\": true,\n \"projectManagers\": [],\n \"resources\": [\n \"5ff2e26f3413f40b136719c9\",\n \"5ff2e26f3413f40b136719d1\",\n \"5ff2e2703413f40b136719de\",\n \"5ff2e26f3413f40b136719bf\"\n ],\n \"backgroundColor\": \"#81A489\",\n \"metadata\": \"\",\n \"customFields\": [],\n \"projectRate\": {\n \"external\": {\n \"customRates\": [],\n \"defaultRateId\": null\n },\n \"internal\": {\n \"customRates\": [],\n \"defaultRateId\": null\n }\n },\n \"customers\": [],\n \"defaultCategory\": \"5ff2e26c3413f40b1367194e\"\n }\n]"}],"_postman_id":"c2622598-8730-45eb-b93f-584540bc4221"},{"name":"Project search","id":"c0c8ad7e-4fd7-4fe6-8f48-a5230b595ab5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

API Key you get from your Hub Planner account page.

If you only want a certain status of project such as STATUS_ACTIVE.

{\"status\" : \"STATUS_ACTIVE\" }\n

will return all projects which are NOT STATUS_ACTIVE

{\"status\" : {\"$nin\": [\"STATUS_ACTIVE\"] } }\n

will return all projects which are STATUS_ACTIVE and STATUS_FLOATING

{\"name\" : {\"$in\": [\"STATUS_ACTIVE\", \"STATUS_FLOATING\"] } }\n

Search Parameters

Use paramters to narrow you search. For example use $nin for not included, and use $in for included.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Parameters
$nin	not included
$in	included
$lt	less than
$lte	less than or equal
$gte	greater than

Searchable Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Parameters	Description
_id	$nin, $in	project id
metadata	$nin, $in	custom meta data field
name	$nin, $in	project name
projectCode	$nin, $in	project code
status	$nin, $in	project status
resources	$nin, $in	project resource id
start	$lt, $lte, $gte	project start
end	$lt, $lte, $gte	project end

API Key you get from your Hub Planner account page.

\n","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{API_URL}}/project/{{PROJECT_ID}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","name":"Hub Planner API","type":"collection"}},"urlObject":{"path":["project","{{PROJECT_ID}}"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"1d4a218c-e1a9-4442-a520-8cb09ad1a505","name":"Get Project by ID","originalRequest":{"method":"GET","header":[{"description":"API Key you get from your Hub Planner account page. ","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{API_URL}}/project/{{PROJECT_ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Jan 2021 12:06:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1264"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609933304"},{"key":"X-RateLimit-Remaining","value":"5991"},{"key":"ETag","value":"W/\"4f0-vs85qT2DuYMbIdMr9GUgomYry2s\""},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5ff451c74e6a950b5cdeb4e5\",\n \"name\": \"Testing\",\n \"links\": {\n \"link1\": \"\",\n \"iconLink1\": \"fa-link\",\n \"link2\": \"\",\n \"iconLink2\": \"fa-link\",\n \"link3\": \"\",\n \"iconLink3\": \"fa-link\",\n \"link4\": \"\",\n \"iconLink4\": \"fa-link\",\n \"link5\": \"\",\n \"iconLink5\": \"fa-link\"\n },\n \"note\": \"\",\n \"createdDate\": \"2021-01-05T11:47:19.816Z\",\n \"updatedDate\": \"2021-01-05T11:47:19.816Z\",\n \"timeEntryEnabled\": true,\n \"timeEntryLocked\": false,\n \"timeEntryApproval\": false,\n \"projectCode\": \"test\",\n \"tags\": [],\n \"timeEntryNoteRequired\": false,\n \"workDays\": [\n false,\n true,\n true,\n true,\n true,\n true,\n false\n ],\n \"useProjectDays\": false,\n \"budget\": {\n \"hasBudget\": false,\n \"projectHours\": {\n \"active\": false,\n \"hours\": 0\n },\n \"cashAmount\": {\n \"active\": false,\n \"amount\": 0,\n \"currency\": \"USD\",\n \"billingRate\": {\n \"useDefault\": false,\n \"rate\": 0,\n \"id\": null\n }\n }\n },\n \"budgetHours\": 0,\n \"budgetCashAmount\": 0,\n \"budgetCurrency\": \"USD\",\n \"companyBillingRateId\": null,\n \"resourceRates\": [],\n \"useStatusColor\": true,\n \"status\": \"STATUS_ACTIVE\",\n \"useProjectDuration\": false,\n \"start\": null,\n \"end\": null,\n \"includeBookedTimeReports\": true,\n \"includeBookedTimeGrid\": true,\n \"private\": true,\n \"projectManagers\": [],\n \"resources\": [],\n \"backgroundColor\": \"#81A489\",\n \"metadata\": \"\",\n \"customFields\": [],\n \"projectRate\": {\n \"external\": {\n \"defaultRateId\": null,\n \"customRates\": []\n },\n \"internal\": {\n \"defaultRateId\": null,\n \"customRates\": []\n }\n },\n \"customers\": [],\n \"defaultCategory\": \"5ff2e26c3413f40b1367194e\"\n}"}],"_postman_id":"6bc63fff-de81-4062-a4fc-c70ff9442f49"},{"name":"Get Project Custom Fields","id":"c08b79b9-1bd8-4c1a-aea4-a1eb1d06693e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{API_URL}}/project/customField/template","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","name":"Hub Planner API","type":"collection"}},"urlObject":{"path":["project","customField","template"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"44ec8cb7-f477-423b-a9ba-1359170b2d4f","name":"Get Project Custom Fields","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{API_URL}}/project/customField/template"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Jan 2021 13:24:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"656"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609933304"},{"key":"X-RateLimit-Remaining","value":"5971"},{"key":"ETag","value":"W/\"290-s3hiaRZKeo/4jcNdo3P5p9nXm1Y\""},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"5ff468444e6a950b5cded4b6\",\n \"filterGrid\": true,\n \"deleted\": false,\n \"company\": \"5ff2e26c3413f40b13671947\",\n \"label\": \"Location\",\n \"instructions\": \"\",\n \"defaultValue\": \"\",\n \"defaultRadioId\": \"\",\n \"placeholderText\": \"Pick location\",\n \"createdDate\": \"2021-01-05T13:23:16.865Z\",\n \"choices\": [\n {\n \"value\": \"US\",\n \"_id\": \"5ff4687d98cd620afa9587f0\"\n },\n {\n \"value\": \"EU\",\n \"_id\": \"5ff468811561080b3c306bd7\"\n },\n {\n \"value\": \"Asia\",\n \"_id\": \"5ff46887e47abe0b1e121f1a\"\n }\n ],\n \"canResourceEdit\": false,\n \"type\": \"SELECT\",\n \"category\": \"PROJECT\",\n \"status\": \"ACTIVE\",\n \"__v\": 1,\n \"allowMultipleValues\": false,\n \"characterLimit\": 0,\n \"maxValue\": 0,\n \"minValue\": 0,\n \"order\": 1,\n \"stepValue\": 0,\n \"updatedDate\": \"2021-01-05T13:24:51.572Z\",\n \"weekStartOn\": 1\n }\n]"}],"_postman_id":"c08b79b9-1bd8-4c1a-aea4-a1eb1d06693e"},{"name":"Create a Project","id":"05db9949-c624-48e3-8db4-685267aaeb3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"

API Key you get from your Hub Planner account page.

Creates a new project/s.

To create multiple project at once, pass in an array of objects.

\n","urlObject":{"path":["project"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"17ab4b55-303e-40ce-af85-fe16a0348bee","name":"Create a Project","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"API Key you get from your Hub Planner account page. ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"My First Project\"\n}"},"url":"{{API_URL}}/project"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Jan 2021 12:08:29 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1234"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609933304"},{"key":"X-RateLimit-Remaining","value":"5990"},{"key":"ETag","value":"W/\"4d2-DxYoD66n9l6BK82skZKNUoV/EgA\""}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5ff456bde47abe0b1e11fe40\",\n \"name\": \"My First Project\",\n \"links\": {\n \"link1\": \"\",\n \"iconLink1\": \"\",\n \"link2\": \"\",\n \"iconLink2\": \"\",\n \"link3\": \"\",\n \"iconLink3\": \"\",\n \"link4\": \"\",\n \"iconLink4\": \"\",\n \"link5\": \"\",\n \"iconLink5\": \"\"\n },\n \"note\": \"\",\n \"createdDate\": \"2021-01-05T12:08:29.722Z\",\n \"updatedDate\": \"2021-01-05T12:08:29.722Z\",\n \"timeEntryEnabled\": true,\n \"timeEntryLocked\": false,\n \"timeEntryApproval\": false,\n \"projectCode\": \"\",\n \"tags\": [],\n \"timeEntryNoteRequired\": false,\n \"workDays\": [\n false,\n true,\n true,\n true,\n true,\n true,\n false\n ],\n \"useProjectDays\": false,\n \"budget\": {\n \"hasBudget\": false,\n \"projectHours\": {\n \"active\": false,\n \"hours\": 0\n },\n \"cashAmount\": {\n \"active\": false,\n \"amount\": 0,\n \"currency\": \"USD\",\n \"billingRate\": {\n \"useDefault\": false,\n \"rate\": 0,\n \"id\": null\n }\n }\n },\n \"budgetHours\": 0,\n \"budgetCashAmount\": 0,\n \"budgetCurrency\": \"USD\",\n \"companyBillingRateId\": null,\n \"resourceRates\": [],\n \"useStatusColor\": true,\n \"status\": \"STATUS_ACTIVE\",\n \"useProjectDuration\": false,\n \"start\": null,\n \"end\": null,\n \"includeBookedTimeReports\": true,\n \"includeBookedTimeGrid\": true,\n \"private\": true,\n \"projectManagers\": [],\n \"resources\": [],\n \"backgroundColor\": \"#81A489\",\n \"metadata\": \"\",\n \"customFields\": [],\n \"projectRate\": {\n \"external\": {\n \"defaultRateId\": null,\n \"customRates\": []\n },\n \"internal\": {\n \"defaultRateId\": null,\n \"customRates\": []\n }\n },\n \"customers\": [],\n \"defaultCategory\": \"5ff2e26c3413f40b1367194e\"\n}"},{"id":"22234fec-82b3-4fb9-83f3-8dd7243244c2","name":"Create a Project with Custom Fields","originalRequest":{"method":"POST","header":[{"description":"API Key you get from your Hub Planner account page. ","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Top Secret for Pentagon\",\n \"customFields\": [\n {\n \"templateId\": \"5ff468444e6a950b5cded4b6\",\n \"templateType\": \"SELECT\",\n \"choices\": [\n {\n \"choiceId\": \"5ff4687d98cd620afa9587f0\",\n \"value\": \"US\"\n }\n ]\n }\n ]\n}"},"url":"{{API_URL}}/project"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Jan 2021 13:28:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1371"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609933304"},{"key":"X-RateLimit-Remaining","value":"5969"},{"key":"ETag","value":"W/\"55b-zMmG85irXALco3jLwTrQHjEVcS0\""}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5ff4699898cd620afa958f9a\",\n \"name\": \"Top Secret for Pentagon\",\n \"links\": {\n \"link1\": \"\",\n \"iconLink1\": \"\",\n \"link2\": \"\",\n \"iconLink2\": \"\",\n \"link3\": \"\",\n \"iconLink3\": \"\",\n \"link4\": \"\",\n \"iconLink4\": \"\",\n \"link5\": \"\",\n \"iconLink5\": \"\"\n },\n \"note\": \"\",\n \"createdDate\": \"2021-01-05T13:28:56.220Z\",\n \"updatedDate\": \"2021-01-05T13:28:56.220Z\",\n \"timeEntryEnabled\": true,\n \"timeEntryLocked\": false,\n \"timeEntryApproval\": false,\n \"projectCode\": \"\",\n \"tags\": [],\n \"timeEntryNoteRequired\": false,\n \"workDays\": [\n false,\n true,\n true,\n true,\n true,\n true,\n false\n ],\n \"useProjectDays\": false,\n \"budget\": {\n \"hasBudget\": false,\n \"projectHours\": {\n \"active\": false,\n \"hours\": 0\n },\n \"cashAmount\": {\n \"active\": false,\n \"amount\": 0,\n \"currency\": \"USD\",\n \"billingRate\": {\n \"useDefault\": false,\n \"rate\": 0,\n \"id\": null\n }\n }\n },\n \"budgetHours\": 0,\n \"budgetCashAmount\": 0,\n \"budgetCurrency\": \"USD\",\n \"companyBillingRateId\": null,\n \"resourceRates\": [],\n \"useStatusColor\": true,\n \"status\": \"STATUS_ACTIVE\",\n \"useProjectDuration\": false,\n \"start\": null,\n \"end\": null,\n \"includeBookedTimeReports\": true,\n \"includeBookedTimeGrid\": true,\n \"private\": true,\n \"projectManagers\": [],\n \"resources\": [],\n \"backgroundColor\": \"#81A489\",\n \"metadata\": \"\",\n \"customFields\": [\n {\n \"templateId\": \"5ff468444e6a950b5cded4b6\",\n \"_id\": \"5ff46ad21561080b3c307276\",\n \"templateType\": \"SELECT\",\n \"templateLabel\": \"\",\n \"choices\": [\n {\n \"value\": \"US\",\n \"choiceId\": \"5ff4687d98cd620afa9587f0\",\n \"_id\": \"5ff46ad21561080b3c307277\"\n }\n ]\n }\n ],\n \"projectRate\": {\n \"external\": {\n \"defaultRateId\": null,\n \"customRates\": []\n },\n \"internal\": {\n \"defaultRateId\": null,\n \"customRates\": []\n }\n },\n \"customers\": [],\n \"defaultCategory\": \"5ff2e26c3413f40b1367194e\"\n}"},{"id":"8fd46757-bffa-4b86-b9cb-922f9df69235","name":"Create multiple Projects","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"API Key you get from your Hub Planner account page. ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n\t \"name\": \"UX Designing\",\n \"projectCode\": \"ux\"\n },\n {\n \"name\": \"Managing\"\n }\n]"},"url":"{{API_URL}}/project"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Jan 2021 12:10:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2461"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609933304"},{"key":"X-RateLimit-Remaining","value":"5989"},{"key":"ETag","value":"W/\"99d-GkizJO/ZMe4lQoHoks3D3zoyRWQ\""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"5ff4574898cd620afa956793\",\n \"name\": \"UX Designing\",\n \"links\": {\n \"link1\": \"\",\n \"iconLink1\": \"\",\n \"link2\": \"\",\n \"iconLink2\": \"\",\n \"link3\": \"\",\n \"iconLink3\": \"\",\n \"link4\": \"\",\n \"iconLink4\": \"\",\n \"link5\": \"\",\n \"iconLink5\": \"\"\n },\n \"note\": \"\",\n \"createdDate\": \"2021-01-05T12:10:48.301Z\",\n \"updatedDate\": \"2021-01-05T12:10:48.301Z\",\n \"timeEntryEnabled\": true,\n \"timeEntryLocked\": false,\n \"timeEntryApproval\": false,\n \"projectCode\": \"ux\",\n \"tags\": [],\n \"timeEntryNoteRequired\": false,\n \"workDays\": [\n false,\n true,\n true,\n true,\n true,\n true,\n false\n ],\n \"useProjectDays\": false,\n \"budget\": {\n \"hasBudget\": false,\n \"projectHours\": {\n \"active\": false,\n \"hours\": 0\n },\n \"cashAmount\": {\n \"active\": false,\n \"amount\": 0,\n \"currency\": \"USD\",\n \"billingRate\": {\n \"useDefault\": false,\n \"rate\": 0,\n \"id\": null\n }\n }\n },\n \"budgetHours\": 0,\n \"budgetCashAmount\": 0,\n \"budgetCurrency\": \"USD\",\n \"companyBillingRateId\": null,\n \"resourceRates\": [],\n \"useStatusColor\": true,\n \"status\": \"STATUS_ACTIVE\",\n \"useProjectDuration\": false,\n \"start\": null,\n \"end\": null,\n \"includeBookedTimeReports\": true,\n \"includeBookedTimeGrid\": true,\n \"private\": true,\n \"projectManagers\": [],\n \"resources\": [],\n \"backgroundColor\": \"#81A489\",\n \"metadata\": \"\",\n \"customFields\": [],\n \"projectRate\": {\n \"external\": {\n \"defaultRateId\": null,\n \"customRates\": []\n },\n \"internal\": {\n \"defaultRateId\": null,\n \"customRates\": []\n }\n },\n \"customers\": [],\n \"defaultCategory\": \"5ff2e26c3413f40b1367194e\"\n },\n {\n \"_id\": \"5ff4574898cd620afa95679e\",\n \"name\": \"Managing\",\n \"links\": {\n \"link1\": \"\",\n \"iconLink1\": \"\",\n \"link2\": \"\",\n \"iconLink2\": \"\",\n \"link3\": \"\",\n \"iconLink3\": \"\",\n \"link4\": \"\",\n \"iconLink4\": \"\",\n \"link5\": \"\",\n \"iconLink5\": \"\"\n },\n \"note\": \"\",\n \"createdDate\": \"2021-01-05T12:10:48.318Z\",\n \"updatedDate\": \"2021-01-05T12:10:48.318Z\",\n \"timeEntryEnabled\": true,\n \"timeEntryLocked\": false,\n \"timeEntryApproval\": false,\n \"projectCode\": \"\",\n \"tags\": [],\n \"timeEntryNoteRequired\": false,\n \"workDays\": [\n false,\n true,\n true,\n true,\n true,\n true,\n false\n ],\n \"useProjectDays\": false,\n \"budget\": {\n \"hasBudget\": false,\n \"projectHours\": {\n \"active\": false,\n \"hours\": 0\n },\n \"cashAmount\": {\n \"active\": false,\n \"amount\": 0,\n \"currency\": \"USD\",\n \"billingRate\": {\n \"useDefault\": false,\n \"rate\": 0,\n \"id\": null\n }\n }\n },\n \"budgetHours\": 0,\n \"budgetCashAmount\": 0,\n \"budgetCurrency\": \"USD\",\n \"companyBillingRateId\": null,\n \"resourceRates\": [],\n \"useStatusColor\": true,\n \"status\": \"STATUS_ACTIVE\",\n \"useProjectDuration\": false,\n \"start\": null,\n \"end\": null,\n \"includeBookedTimeReports\": true,\n \"includeBookedTimeGrid\": true,\n \"private\": true,\n \"projectManagers\": [],\n \"resources\": [],\n \"backgroundColor\": \"#81A489\",\n \"metadata\": \"\",\n \"customFields\": [],\n \"projectRate\": {\n \"external\": {\n \"defaultRateId\": null,\n \"customRates\": []\n },\n \"internal\": {\n \"defaultRateId\": null,\n \"customRates\": []\n }\n },\n \"customers\": [],\n \"defaultCategory\": \"5ff2e26c3413f40b1367194e\"\n }\n]"}],"_postman_id":"05db9949-c624-48e3-8db4-685267aaeb3e"},{"name":"Update Project","id":"55453f88-1ea8-4d8a-975b-c72059bd3955","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"description":"

API Key you get from your Hub Planner account page.

\n","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Testing\",\n\t\"projectCode\": \"test\"\n}"},"url":"{{API_URL}}/project/{{PROJECT_ID}}","description":"

Update a Project. There is no need to send the whole project object, just properties that should be changed.

You can also use PATCH method with only one object included in array.

\n","urlObject":{"path":["project","{{PROJECT_ID}}"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"af83cbc5-c72d-4852-ac49-be03f3b7c3b2","name":"Update Project","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"API Key you get from your Hub Planner account page. ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Testing\",\n\t\"projectCode\": \"test\"\n}"},"url":"{{API_URL}}/project/{{PROJECT_ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Jan 2021 12:20:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1264"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609933304"},{"key":"X-RateLimit-Remaining","value":"5984"},{"key":"ETag","value":"W/\"4f0-a+0VgPJSbJuNbv+FiU9kp7IujRM\""},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5ff451c74e6a950b5cdeb4e5\",\n \"name\": \"Testing\",\n \"links\": {\n \"link1\": \"\",\n \"iconLink1\": \"fa-link\",\n \"link2\": \"\",\n \"iconLink2\": \"fa-link\",\n \"link3\": \"\",\n \"iconLink3\": \"fa-link\",\n \"link4\": \"\",\n \"iconLink4\": \"fa-link\",\n \"link5\": \"\",\n \"iconLink5\": \"fa-link\"\n },\n \"note\": \"\",\n \"createdDate\": \"2021-01-05T11:47:19.816Z\",\n \"updatedDate\": \"2021-01-05T12:20:11.000Z\",\n \"timeEntryEnabled\": true,\n \"timeEntryLocked\": false,\n \"timeEntryApproval\": false,\n \"projectCode\": \"test\",\n \"tags\": [],\n \"timeEntryNoteRequired\": false,\n \"workDays\": [\n false,\n true,\n true,\n true,\n true,\n true,\n false\n ],\n \"useProjectDays\": false,\n \"budget\": {\n \"hasBudget\": false,\n \"projectHours\": {\n \"active\": false,\n \"hours\": 0\n },\n \"cashAmount\": {\n \"active\": false,\n \"amount\": 0,\n \"currency\": \"USD\",\n \"billingRate\": {\n \"useDefault\": false,\n \"rate\": 0,\n \"id\": null\n }\n }\n },\n \"budgetHours\": 0,\n \"budgetCashAmount\": 0,\n \"budgetCurrency\": \"USD\",\n \"companyBillingRateId\": null,\n \"resourceRates\": [],\n \"useStatusColor\": true,\n \"status\": \"STATUS_ACTIVE\",\n \"useProjectDuration\": false,\n \"start\": null,\n \"end\": null,\n \"includeBookedTimeReports\": true,\n \"includeBookedTimeGrid\": true,\n \"private\": true,\n \"projectManagers\": [],\n \"resources\": [],\n \"backgroundColor\": \"#81A489\",\n \"metadata\": \"\",\n \"customFields\": [],\n \"projectRate\": {\n \"external\": {\n \"defaultRateId\": null,\n \"customRates\": []\n },\n \"internal\": {\n \"defaultRateId\": null,\n \"customRates\": []\n }\n },\n \"customers\": [],\n \"defaultCategory\": \"5ff2e26c3413f40b1367194e\"\n}"}],"_postman_id":"55453f88-1ea8-4d8a-975b-c72059bd3955"},{"name":"Update Multiple Projects","id":"de7214cd-2826-4ddb-b547-b0bdc0b66b9c","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"

API Key you get from your Hub Planner account page.

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n\t{\n\t\t\"_id\": \"5e21aefe59acb53db004d683\",\n\t\t\"name\": \"Wrong ID\"\n\t},\n\t{\n\t\t\"_id\": \"5ff2e2703413f40b13671a16\",\n\t\t\"not_existed_property\": \"incorrectly\"\n\t},\n\t{\n\t\t\"_id\": \"{{PROJECT_ID}}\",\n\t\t\"name\": \"Test\"\n\t}\n]"},"url":"{{API_URL}}/project","description":"

Updates multiple projects at once.

API Key you get from your Hub Planner account page.

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{API_URL}}/project/{{PROJECT_TO_DELETE_ID}}","urlObject":{"path":["project","{{PROJECT_TO_DELETE_ID}}"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"80850a6a-f39c-4e20-9726-e13956ce9270","name":"Delete a Project","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"API Key you get from your Hub Planner account page. ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{API_URL}}/project/{{PROJECT_TO_DELETE_ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Jan 2021 12:50:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"4"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609933304"},{"key":"X-RateLimit-Remaining","value":"5979"},{"key":"ETag","value":"W/\"4-X/5TO4MPCKAyY0ipFgr6/IraRNs\""},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"0d9ece98-9ade-434a-999c-25e7c5d1b42e"},{"name":"Delete Multiple Projects","id":"96500c9f-4878-4b41-8192-e418f0c0269a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"

API Key you get from your Hub Planner account page.

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\"5ff46049e47abe0b1e120f6a\", \"5ff46049e47abe0b1e120f75\"]"},"url":"{{API_URL}}/project","description":"

Updates multiple projects at once.

API Key you get from your Hub Planner account page.

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"resourceIds\": [\"{{RESOURCE_ID}}\"]\n}"},"url":"{{API_URL}}/project/addResourcesToProject/{{PROJECT_ID}}","urlObject":{"path":["project","addResourcesToProject","{{PROJECT_ID}}"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"5514a563-04ef-461f-b9d4-9bbd17b4e525","name":"Add Resources to a Project","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"API Key you get from your Hub Planner account page. ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"resourceIds\": [\"{{RESOURCE_ID}}\"]\n}"},"url":"{{API_URL}}/project/addResourcesToProject/{{PROJECT_ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Jan 2021 13:06:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"4"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609933304"},{"key":"X-RateLimit-Remaining","value":"5977"},{"key":"ETag","value":"W/\"4-X/5TO4MPCKAyY0ipFgr6/IraRNs\""},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"44e393e8-2029-41b5-98a5-71806c837681"},{"name":"Remove Resource from Projects","id":"babf87cb-80ac-4b73-b649-7cf037820971","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"

API Key you get from your Hub Planner account page.

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"projectIds\": [\"{{PROJECT_ID}}\"]\n}"},"url":"{{API_URL}}/project/removeResourceFromProjects/{{RESOURCE_ID}}","urlObject":{"path":["project","removeResourceFromProjects","{{RESOURCE_ID}}"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"63104f46-7cbf-4dd9-a0b0-e1a612a70df6","name":"Remove Resource from Projects","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"API Key you get from your Hub Planner account page. ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"projectIds\": [\"{{PROJECT_ID}}\"]\n}"},"url":"{{API_URL}}/project/removeResourceFromProjects/{{RESOURCE_ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Jan 2021 13:12:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"4"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609933304"},{"key":"X-RateLimit-Remaining","value":"5976"},{"key":"ETag","value":"W/\"4-X/5TO4MPCKAyY0ipFgr6/IraRNs\""},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"babf87cb-80ac-4b73-b649-7cf037820971"},{"name":"Get Project Clients","id":"bcd26134-e9f8-4a9b-b810-40cce4dd0930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"

API Key you get from your Hub Planner account page.

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{API_URL}}/project/{{PROJECT_ID}}/client","urlObject":{"path":["project","{{PROJECT_ID}}","client"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bcd26134-e9f8-4a9b-b810-40cce4dd0930"},{"name":"Add Clients to a Project","id":"22f74afa-418c-45f7-9922-294d9db2e632","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"

API Key you get from your Hub Planner account page.

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientIds\": [\"{{CLIENT_ID}}\"]\n}"},"url":"{{API_URL}}/project/{{PROJECT_ID}}/client","urlObject":{"path":["project","{{PROJECT_ID}}","client"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0fdf699b-a3fe-4b10-9493-d37aed7f8302","name":"Add Clients to a Project","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"API Key you get from your Hub Planner account page. ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientIds\": [\"{{CLIENT_ID}}\"]\n}"},"url":"{{API_URL}}/project/{{PROJECT_ID}}/client"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 14:54:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"4"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1610111643"},{"key":"X-RateLimit-Remaining","value":"5960"},{"key":"ETag","value":"W/\"4-X/5TO4MPCKAyY0ipFgr6/IraRNs\""},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"22f74afa-418c-45f7-9922-294d9db2e632"},{"name":"Remove a Client from Projects","id":"b9aff7f7-085b-45e5-b522-1607f7eab348","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{API_KEY}}","description":"

API Key you get from your Hub Planner account page.

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"projectIds\": [\"{{PROJECT_ID}}\"]\n}"},"url":"{{API_URL}}/project/client/{{CLIENT_ID}}","urlObject":{"path":["project","client","{{CLIENT_ID}}"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b9aff7f7-085b-45e5-b522-1607f7eab348"}],"id":"e7022b08-5c03-4e33-85ce-7a714538e28b","description":"

Projects API goes here

\n","_postman_id":"e7022b08-5c03-4e33-85ce-7a714538e28b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","name":"Hub Planner API","type":"collection"}}},{"name":"Public Holidays","item":[{"name":"Get All Public Holiday Calendars","id":"24a52a3d-b30e-4429-b0b0-43ac6aecb1ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{API_URL}}/calendar","description":"

Get All Public Holiday Calendars

GET /calendar\n

The call will return an array of calendars for your company. By default customer has one calendar, called \"Company Holidays\". With the Global Public Holidays extension installed you can create more calendars.

The following is a description of the properties in the response.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description	Required	Sortable
_id	string	id of the Calendar	NO	NO
name	string	Calendar Name (Unique)	NO	YES
metadata	string	Custom Field (255 Characters)	NO	YES
createdDate	string	Calendar Creation Date	NO	YES
updatedDate	string	Calendar Updated Date	NO	YES
holidays	object array	A list of holidays, read the Holidays section to see how to set them	NO	NO

Get A Public Holiday Calendar by ID

Use the following command to get a specific calendar by id.

GET /calendar/12345678\n

Will return a calendar with the id 12345678

A successful resource will return a 200 Ok response status from the server.

Create a Public Holiday Calendar.

Customer calendars are part of a 'Global Public Holiday Calendars' extension. If the extension is not installed or your trial period is ended the following error will be returned by the server:

{\n    \"message\": \"The extension 'holiday_calendars' is required to perform this action. Please activate it and try again.\",\n    \"error\": \"EXTENSION_IS_NOT_ACTIVE\",\n    \"code\": \"A2424\",\n    \"properties\": {\n        \"additionalInformation\": {\n            \"extensionName\": \"holiday_calendars\"\n        }\n    },\n    \"version\": 2\n}\n

To create a new calendar make a following request:

POST /calendar\n

with an example payload:

{\n    \"name\": \"North American Team\"\n}\n

The server will return the full calendar object once created including the newly created resource ID _id

{\n    \"_id\": \"1234567\",\n    \"name\": \"North American Team\",\n    \"metadata\": \"\",\n    \"createdDate\": \"2021-12-11T14:32:34.540Z\",\n    \"updatedDate\": \"2021-12-11T14:32:34.540Z\",\n    \"holidays\": []\n}\n

A successful create operation will return a 201 OK response status from the server.

##Update an Existing Public Holiday Calendar

PUT /calendar/123456789\n

will update the calendar with the id 123456789. You must pass in the entire calendar object in the body when updating so no values will be overwritten to default. Best practice will be to read first and then merge.

A successful update will return a 200 Ok response status from the server.

Delete a Public Holiday Calendar

Use the following command to delete a specific public holiday calendar by id. Will delete a calendar with the id {{CALENDAR_ID}}

A successful delete will return a 200 Ok response status from the server.

##Add a calendar to a resource

This feature is available only to customers that have purchaced the 'Calendar and Holidays' extension.

In order to assign a specific calendar to a resource, update a resource by passing additional 'calendarIds' field into a request payload.

PUT /resource/1234567890\n

Request payload

{\n    \"firstName\": \"Name\",\n    \"lastName\": \"Lastname\",\n    \"calendarIds\": [\n       \"12345\",\n       \"56789\"\n    ]\n}\n

A new set of calendars '12345' and '56789' will be assigned to the resource with id '1234567890'.

A successful update will return a 200 Ok response status from the server.

Get All Calendars

GET /calendar\n

The call will return an array of calendars. By default customer has one calendar, called \"Company Holidays\".

The following is a description of the properties in the response.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description	Required	Sortable
_id	string	id of the Calendar	NO	NO
name	string	Calendar Name (Unique)	NO	YES
metadata	string	Custom Field (255 Characters)	NO	YES
createdDate	string	Calendar Creation Date	NO	YES
updatedDate	string	Calendar Updated Date	NO	YES
holidays	object array	A list of holidays, read the Holidays section to see how to set them	NO	NO

Get All Calendars

GET /calendar\n

The call will return an array of calendars. By default customer has one calendar, called \"Company Holidays\".

The following is a description of the properties in the response.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description	Required	Sortable
_id	string	id of the Calendar	NO	NO
name	string	Calendar Name (Unique)	NO	YES
metadata	string	Custom Field (255 Characters)	NO	YES
createdDate	string	Calendar Creation Date	NO	YES
updatedDate	string	Calendar Updated Date	NO	YES
holidays	object array	A list of holidays, read the Holidays section to see how to set them	NO	NO

##Create a new Holiday in a specific calendar

Customer calendars are part of a 'Holiday Calendars' extension. If the extension is not installed or your trial period is ended the following error will be returned by the server:

{\n    \"message\": \"The extension 'holiday_calendars' is required to perform this action. Please activate it and try again.\",\n    \"error\": \"EXTENSION_IS_NOT_ACTIVE\",\n    \"code\": \"A2424\",\n    \"properties\": {\n        \"additionalInformation\": {\n            \"extensionName\": \"holiday_calendars\"\n        }\n    },\n    \"version\": 2\n}\n

POST /holiday\n

An example of a Holiday assigned to calendar '1234567'

{ \n  \"name\":\"Christmas 2020\",\n  \"date\":\"2020-12-25\",\n  \"calendarId\": \"1234567\"\n}\n

The server will return the full holiday object once created including the newly created holiday ID _id

A successful create will return a 201 Ok response status from the server.

The Public Holidays API allows you to control the public holidays feature in Hub Planner. Each account has a default calendar you can use for your public holidays and assign team members too. With the Global Public Holidays extension installed you can also create multiple calendars for different teams and regions.

Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
{{CALENDAR_ID}}	ID of a calendar
{{HOLIDAY_ID}}	ID of a Holiday.

","event":[{"listen":"prerequest","script":{"id":"3139b4b4-ebfc-44a7-824a-1aa9ff6d61cc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8f1a3962-3960-408d-afa1-093d5285c8ae","type":"text/javascript","exec":[""]}}],"_postman_id":"3a1e3ae6-703e-48e8-9358-afa713d28c4f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","name":"Hub Planner API","type":"collection"}}},{"name":"Booking Categories","item":[{"name":"Get All Booking Categories","id":"a03b5152-eae8-4db6-b4a1-69219e1d46e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{API_URL}}/categories?limit=1000","description":"

The call will return an array of booking categories for your company.

Property type shows if the booking category is default in its group. It can be set as NON_OPTIONAL (default) or CUSTOM.

Use the following command to search booking categories, it allows to get more complex results.

Search Parameters

Use paramters to narrow you search. You can send exact values or use parameters below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Description
$in	values included in array
$nin	values excluded from array

Searchable Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Parameters	Type
_id	$in, $nin	ID
name	$in, $nin	string
type	$in, $nin	string
gridColor	$in, $nin	string
group		ID

To get categories from other groups than default, there is extension \"Booking Category Groups\" required.

Use the following command to get a specific booking category by id.

A successful resource will return a 200 Ok response status from the server.

In the body you have to send ID of the group to add new booking category.\nPossible values of property type are NON_OPTIONAL and CUSTOM. Setting type to NON_OPTIONAL sets the new category as default one in the group.

A successful create operation will return a 201 OK response status from the server.

You must pass in the entire object in the body when updating so no values will be overwritten. Best practice will be to read first and then merge.

A successful update will return a 200 Ok response status from the server.

Use the following command to delete a specific booking category by id.\nYou are not allowed to delete default type = \"NON_OPTIONAL\" category. First you have to set different category as default.

A successful delete will return a 204 Ok response status from the server.

The call will return an array of category groups for your company.

The properties returned are displayed in example.\nProperty type shows if the category group is default. It can be set as NON_OPTIONAL (default) or CUSTOM.

To receive CUSTOM gorups, there is extension \"Booking Category Groups\" required.

Use the following command to search category groups, it allows to get more complex results.

Search Parameters

Use paramters to narrow you search. You can send exact values or use parameters below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Description
$in	values included in array
$nin	values excluded from array

Searchable Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Parameters	Type
_id	$in, $nin	ID
name	$in, $nin	string
type	$in, $nin	string

In response property categories holds all booking category IDs related to this group.

To receive CUSTOM gorups, there is extension \"Booking Category Groups\" required.

Use the following command to get a specific category group by id.

A successful resource will return a 200 Ok response status from the server.

To receive CUSTOM gorups, there is extension \"Booking Category Groups\" required.

During creation of new category group, default category General for the group is created.

You can use property projectIds to add the new group to projects.

A successful create operation will return a 201 OK response status from the server.

You must pass in the entire object in the body when updating so no values will be overwritten. Best practice will be to read first and then merge.

A successful update will return a 200 Ok response status from the server.

Use the following command to delete a specific booking category by id.\nYou are not allowed to delete default type = \"NON_OPTIONAL\" category group.

Deleting a category group will cause in deleting all booking categories in it and removing it from projects.

A successful delete will return a 204 Ok response status from the server.

API Key you get from your Hub Planner account page.

\n","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"2023-10-05\",\n \"to\": \"2023-10-05\",\n \"resourceId\": \"65aa1d13d1428241e0b4a7a1\",\n \"intervals\": [\n {\n \"start\": 120,\n \"end\": 150\n }\n ]\n}"},"url":"{{API_URL}}/customAvailabilityOverride/","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description	Default	Required	Sortable
_id	string	id of the custom availability override	System	NO	-
resourceId	string	id of the Resource	-	YES	-
from	string	Date	-	YES	-
to	string	Date	-	YES	-
minutes	number	Time based on intervals - it's calculated by the system	System	NO	-
intervals	object array	Set the intervals on the resource. Leave array empty to mark day as unavailable.	-	YES	-
createdDate	string	Custom availability override creation date	System	NO	-

Interval object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description	Default	Required	Sortable
_id	string	id of the Interval	System	NO	-
start	number	Minute value where midnight is 0 (01:00 is 60 etc.)	-	YES	-
end	number	Minute value where midnight is 0 (01:00 is 60 etc.)	-	YES	-

Create Multiple Resources

To create multiple resources, use the same endpoint and pass all objects in an array []

  [\n   {\n      \"firstName\":\"Sam\",\n      \"lastName\":\"Nolan\",\n      \"email\":\"sam.nolan@hubplanner.com\"\n   },\n   {\n      \"firstName\":\"Rich\",\n      \"lastName\":\"Curran\",\n      \"email\":\"rich.curran@hubplanner.com\"\n   }\n]\n\n

","urlObject":{"path":["customAvailabilityOverride",""],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"06d26248-6cea-4ed0-bae9-da6b66ea373f","name":"Create custom availability override","originalRequest":{"method":"POST","header":[{"description":"API Key you get from your Hub Planner account page. ","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"2023-10-05\",\n \"to\": \"2023-10-05\",\n \"resourceId\": \"65aa1d13d1428241e0b4a7a1\",\n \"intervals\": [\n {\n \"start\": 120,\n \"end\": 150\n }\n ]\n}"},"url":"{{API_URL}}/customAvailabilityOverride/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Jan 2021 11:10:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1044"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609840182"},{"key":"X-RateLimit-Remaining","value":"5983"},{"key":"ETag","value":"W/\"414-2HQoPXWEARH5l5ZFwrGp5vOm4DU\""}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"65f2a71a3060583a40315160\",\n \"minutes\": 30,\n \"from\": \"2023-10-05\",\n \"to\": \"2023-10-05\",\n \"resourceId\": \"65aa1d13d1428241e0b4a7a1\",\n \"intervals\": [\n {\n \"start\": 120,\n \"end\": 150,\n \"_id\": \"65f2a71a3060583a40315161\"\n }\n ],\n \"createdDate\": \"2024-03-14T07:28:26.591Z\"\n}"}],"_postman_id":"bc433d53-1329-4fd1-bda9-8a23e0e245d4"},{"name":"Update custom availability override","id":"de864fb1-e830-4ec6-b78b-71a09722aca4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"description":"

API Key you get from your Hub Planner account page.

\n","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"minutes\": 60,\n \"repeat\": false,\n \"interval\": \"NONE\",\n \"repeatTimes\": 0,\n \"from\": \"2023-10-05\",\n \"to\": \"2023-10-05\",\n \"resourceId\": \"65aa1d13d1428241e0b4a7a1\",\n \"companyId\": \"6593f956d79fd7797ca4e95e\",\n \"intervals\": [\n {\n \"start\": 120,\n \"end\": 180,\n \"_id\": \"65f1a50fdfe7e41023b18754\"\n }\n ]\n}"},"url":"{{API_URL}}/customAvailabilityOverride/{{OVERRIDE_ID}}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description	Default	Required	Sortable
_id	string	id of the custom availability override	System	NO	-
resourceId	string	id of the Resource	-	YES	-
from	string	Date	-	YES	-
to	string	Date	-	YES	-
minutes	number	Time based on intervals - it's calculated by the system	System	NO	-
intervals	object array	Set the intervals on the resource.	-	YES	-
createdDate	string	Custom availability override creation date	System	NO	-
updatedDate	string	Custom availability override update date	System	NO	-

Interval object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description	Default	Required	Sortable
_id	string	id of the Interval	System	NO	-
start	number	Minute value where midnight is 0 (01:00 is 60 etc.)	-	YES	-
end	number	Minute value where midnight is 0 (01:00 is 60 etc.)	-	YES	-

","urlObject":{"path":["customAvailabilityOverride","{{OVERRIDE_ID}}"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"70cb5b1f-ba19-4505-aa7b-bcf6c781bf0b","name":"Update custom availability override","originalRequest":{"method":"PUT","header":[{"description":"API Key you get from your Hub Planner account page. ","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"2023-10-05\",\n \"to\": \"2023-10-05\",\n \"resourceId\": \"65aa1d13d1428241e0b4a7a1\",\n \"intervals\": [\n {\n \"start\": 120,\n \"end\": 210\n }\n ],\n \"createdDate\": \"2024-03-14T07:28:26.591Z\"\n}"},"url":"{{API_URL}}/customAvailabilityOverride/{{OVERRIDE_ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Jan 2021 11:10:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1044"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609840182"},{"key":"X-RateLimit-Remaining","value":"5983"},{"key":"ETag","value":"W/\"414-2HQoPXWEARH5l5ZFwrGp5vOm4DU\""}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"65f2a71a3060583a40315160\",\n \"minutes\": 90,\n \"from\": \"2023-10-05\",\n \"to\": \"2023-10-05\",\n \"resourceId\": \"65aa1d13d1428241e0b4a7a1\",\n \"intervals\": [\n {\n \"start\": 120,\n \"end\": 210,\n \"_id\": \"65f2a9387ced1d32b08ec268\"\n }\n ],\n \"createdDate\": \"2024-03-14T07:28:26.591Z\",\n \"updatedDate\": \"2024-03-14T07:37:28.581Z\"\n}"}],"_postman_id":"de864fb1-e830-4ec6-b78b-71a09722aca4"},{"name":"Delete custom availability override","id":"ed4f94bf-5af7-456f-b5dc-f2c67fbdef31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"description":"

API Key you get from your Hub Planner account page.

\n","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{API_URL}}/customAvailabilityOverride/{{OVERRIDE_ID}}","urlObject":{"path":["customAvailabilityOverride","{{OVERRIDE_ID}}"],"host":["{{API_URL}}"],"query":[],"variable":[]}},"response":[{"id":"ca61e301-c0a8-425b-9347-142ebe8ec4d0","name":"Delete custom availability override","originalRequest":{"method":"DELETE","header":[{"description":"API Key you get from your Hub Planner account page. ","key":"Authorization","type":"text","value":"{{API_KEY}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{API_URL}}/customAvailabilityOverride/{{OVERRIDE_ID}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Jan 2021 11:10:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1044"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override"},{"key":"Cache-Control","value":"no-store, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'unsafe-inline' 'unsafe-eval' *.hubplanner.com localhost:* *.amazonaws.com https://api.ipstack.com https://*.braintreegateway.com https://*.cardinalcommerce.com https://*.cloudfront.net https://www.google.com https://www.gstatic.com https://www.googletagmanager.com https://www.google-analytics.com https://ssl.google-analytics.com https://zapier.com; frame-src https://www.google.com https://*.braintreegateway.com https://*.cardinalcommerce.com; connect-src *; img-src * data:; style-src * 'unsafe-inline'; font-src *; object-src 'none'"},{"key":"X-RateLimit-Limit","value":"6000"},{"key":"X-RateLimit-Reset","value":"1609840182"},{"key":"X-RateLimit-Remaining","value":"5983"},{"key":"ETag","value":"W/\"414-2HQoPXWEARH5l5ZFwrGp5vOm4DU\""}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ed4f94bf-5af7-456f-b5dc-f2c67fbdef31"}],"id":"d1c6b734-fc98-4113-932e-a222fe92485d","description":"

Resource dynamic capacity allows you to set custom availability on any resource individually. See here for more feature details https://hubplanner.com/kb/set-dynamic-capacity-for-your-team-of-resources/

\n","_postman_id":"d1c6b734-fc98-4113-932e-a222fe92485d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","name":"Hub Planner API","type":"collection"}}},{"name":"Tags","item":[{"name":"New Request","id":"b6ec0301-8d69-4afc-87ff-316311c41e4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","name":"Hub Planner API","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"b6ec0301-8d69-4afc-87ff-316311c41e4d"}],"id":"85c05819-c906-45d4-874e-3140ed602a0d","_postman_id":"85c05819-c906-45d4-874e-3140ed602a0d","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","id":"25afbf89-9124-49cb-a08d-9ca52ec0f4da","name":"Hub Planner API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{API_KEY}}"}]}},"event":[{"listen":"prerequest","script":{"id":"471dead3-b231-400f-af05-68f021233446","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9de0bfd2-d8e2-4554-be00-90d222e7494b","type":"text/javascript","exec":["pm.test('Status code is 200', function () {"," pm.response.to.have.status(200);","});"]}}]}