Skip to main content
Hub Planner logo
  • Category: productivity
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 122
  • Triggers: 0
  • Slug: HUB_PLANNER
  • Version: 20261101_00

Tools

Slug: HUB_PLANNER_ADD_CLIENTS_TO_PROJECTTool to add clients to a project by project ID. Use when you need to associate one or more clients with a specific project.

Input Parameters

array
required
Array of client IDs to add to the project
string
required
Project ID to add clients to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_ADD_PROJECT_CUSTOM_FIELD_CHOICESAdd choices to a project custom field template of SELECT, RADIO, or CHECKBOX type. Use when you need to add new options to an existing dropdown, radio button, or checkbox custom field in Hub Planner projects.

Input Parameters

array
required
List of choice values to add to the custom field template. Each choice must have a ‘value’ property.
string
required
The unique identifier of the custom field template to add choices to. Must be a SELECT, RADIO, or CHECKBOX type template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_ADD_PROJECTS_TO_GROUPTool to add projects to a project group in Hub Planner. Use when you need to associate one or more projects with a specific project group.

Input Parameters

string
required
Project group ID - the unique identifier of the project group to add projects to (e.g., ‘698dca3b4aa5569810418b47’). This is required to specify which project group will receive the projects.
array
required
Array of project IDs to add to the project group. Each ID must be a valid project identifier in the Hub Planner system (e.g., [‘693ed5dad8729e5dc0c811ed’]).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_ADD_PROJECT_TAGSTool to add tags to a Hub Planner project. Preserves existing tags and appends new ones. Use when you need to add one or more tags to a project without removing existing tags.

Input Parameters

array
required
Array of tag IDs to add to the project. These will be appended to existing tags.
string
required
The unique identifier of the project to add tags to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_ADD_RESOURCE_CUSTOM_FIELD_CHOICESTool to add choices to a resource custom field template of SELECT, RADIO, or CHECKBOX type. Use when you need to add new selection options to an existing custom field template.

Input Parameters

string
required
Custom field template ID to add choices to
array
required
Array of choice objects to add to the custom field template. Each choice must have a value property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_ADD_RESOURCES_TO_PROJECTTool to add resources to a project by project ID. Use when you need to associate one or more resources with a specific project.

Input Parameters

string
required
Project ID to add resources to
array
required
Array of resource IDs to add to the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_ADD_RESOURCES_TO_RESOURCE_GROUPTool to add resources to a resource group by group ID. Use when you need to associate one or more resources with a specific resource group.

Input Parameters

string
required
Resource group ID to add resources to
array
required
Array of resource IDs to add to the resource group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_ADD_RESOURCE_TAGSTool to add tags to a resource in Hub Planner. Preserves existing tags and appends new ones. Use when you need to categorize, label, or organize resources using tags.

Input Parameters

array
required
Array of tag IDs to add to the resource. New tags will be appended to existing tags without removing any previously assigned tags.
string
required
The unique identifier of the resource to add tags to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_BILLING_RATETool to create a new billing rate in Hub Planner. Use when you need to define a new billing rate with a specific name, currency, and rate amount.

Input Parameters

number
required
Rate amount in the specified currency. This is the billing rate value that will be charged.
string
required
Billing rate name. This is the display name for the billing rate and is required for creation.
string
required
Currency code for the billing rate (e.g., ‘USD’, ‘EUR’, ‘GBP’). This determines the currency unit for the rate amount.
string
Custom metadata field for storing additional information (max 255 characters)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_BOOKINGCreate a booking for a resource on a project in Hub Planner, including scheduled, approval-request, hourly, or repeating bookings. For repeating bookings returned as a list of details, only the first booking is returned.

Input Parameters

string
required
Booking end date. Use same format as start date (YYYY-MM-DD or YYYY-MM-DD HH:mm).
string
Notes or comments about this booking.
string ("SCHEDULED" | "WAITING_FOR_APPROVAL" | "APPROVED" | "REJECTED")
Valid booking type values.
string
required
Booking start date. Use YYYY-MM-DD format for day bookings or YYYY-MM-DD HH:mm format for hourly bookings.
string ("STATE_DAY_MINUTE" | "STATE_PERCENTAGE" | "STATE_TOTAL_MINUTE")
Valid booking state values.
string
Custom title for the booking. If not provided, defaults to project name.
boolean
Set to false for hourly bookings (requires start/end with HH:mm format). Omit or set to true for all-day bookings.
boolean
Set to true to create a repeating booking. Requires interval to be specified.
string
required
Project ID to associate with this booking. This identifies the project the resource is being booked on.
string ("WEEKLY" | "MONTHLY" | "YEARLY")
Valid repeat interval values.
string
Custom metadata field (max 255 characters)
string
required
Resource ID to assign to this booking. This identifies the team member or resource being booked.
number
Value for the booking state. For STATE_PERCENTAGE, this is percentage (e.g., 100 for 100%). For STATE_DAY_MINUTE, this is minutes per day (e.g., 480 for 8 hours). For STATE_TOTAL_MINUTE, this is total minutes.
object
Billing rate configuration.
array
Array of custom field values for the booking
boolean
Set to true to allow booking even if resource is already fully scheduled. Overrides overscheduling warnings.
integer
Number of times to repeat the booking. Only used when repeat is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_BOOKING_CATEGORYTool to create a new booking category in Hub Planner. Use when you need to define a new category type for classifying bookings (e.g., “At Client”, “Remote Work”, “Training”).

Input Parameters

string
required
Category name. This is the display name for the booking category.
string ("NON_OPTIONAL" | "CUSTOM")
required
Category type. NON_OPTIONAL indicates the default option within the group. CUSTOM indicates a user-defined category. This field is required.
string
required
Category group ID. This identifies the parent group that will contain this booking category.
string
required
Category color in hex format (e.g., ‘#3498db’, ‘#81A489’). This color will be used to display bookings of this category in the calendar/grid views. This field is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_CLIENTTool to create a new client in Hub Planner. Use when you need to add a new client organization to the system.

Input Parameters

string
required
Client name. This is the display name for the client and is required for creation.
string
Custom metadata field for storing additional client information. Can be used for internal notes or custom data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_COST_CATEGORYTool to create a new project cost category in Hub Planner. Use when you need to add a new cost category for tracking project expenses.

Input Parameters

string
required
Cost category name. This is the display name for the cost category and is required for creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_EVENTTool to create a new event in Hub Planner. Use when you need to set up a new event with a specified name and optional code, color, and metadata.

Input Parameters

string
required
Event name. This is the display name for the event and is required for creation.
string
Custom metadata field (maximum 255 characters). Can be used to store additional event information.
string
Unique event code identifier. This is typically used for internal event reference numbers. Must be unique across all events.
string
Event background color as hex code (e.g., ‘#FF5733’). Used for visual identification in calendars and schedules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_HOLIDAYTool to create a new holiday in Hub Planner. Use when you need to add a company holiday, public holiday, or special date that should be marked in the calendar.

Input Parameters

string
required
Holiday date in YYYY-MM-DD format. This is the date when the holiday occurs.
string
required
Holiday name. This is the display name for the holiday and is required for creation.
boolean
Set to true if the holiday repeats yearly. When true, the holiday will automatically recur every year on the same date.
string
Custom metadata field for the holiday. Use this for any additional custom information you want to store with the holiday.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_MILESTONETool to create a new milestone for a project in Hub Planner. Use when you need to set up a milestone with a specified name, date, and project association.

Input Parameters

string
required
Milestone date in YYYY-MM-DD format. This is the target date for the milestone.
string
required
Milestone name. This is the display name for the milestone and is required for creation.
string
required
Project ID to associate with this milestone. This identifies the project the milestone belongs to.
string
Custom metadata field (maximum 255 characters). Can be used to store additional milestone information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_PROJECTTool to create a new project in Hub Planner. Use when you need to set up a new project with specified name, budget, resources, and other configuration options.

Input Parameters

string
required
Project name. This is the display name for the project and is required for creation.
string
Project notes or description. Free-form text field.
string ("STATUS_ACTIVE" | "STATUS_ARCHIVED" | "STATUS_PENDING" | "STATUS_PLANNED" | "STATUS_FLOATING")
Valid project status values.
array
Array of resource IDs to assign to the project. Resources are team members who will work on the project.
number
Total budget hours allocated to the project. Use this for hour-based project budgets.
string
Unique project code identifier. This is typically used for internal project reference numbers or billing codes. Must be unique across all projects.
array
Custom field values for the project. These are user-defined fields configured in your Hub Planner account.
string
Currency code for the budget (e.g., ‘USD’, ‘EUR’, ‘GBP’). Required if budgetCashAmount is specified.
array
Array of resource IDs designated as project managers. These users will have manager-level access to the project.
number
Cash budget amount for the project. Use in conjunction with budgetCurrency.
array
Budget allocations broken down by category. Use this for detailed budget tracking across different project categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_PROJECT_CUSTOM_FIELD_TEMPLATETool to create a new project custom field template in Hub Planner. Use when you need to define reusable custom field structures for projects with specific types like TEXT, SELECT, DATE, etc.

Input Parameters

string ("TEXT" | "TEXTAREA" | "EMAIL" | "DATE" | "COLOR" | "NUMBER" | "CHECKBOX" | "SELECT" | "RADIO")
required
Field type (TEXT, TEXTAREA, EMAIL, DATE, COLOR, NUMBER, CHECKBOX, SELECT, RADIO)
string
required
Field label or name
string ("ACTIVE" | "INACTIVE")
Enum for custom field status.
array
Available choices for SELECT, RADIO, or CHECKBOX field types. Required when type is SELECT, RADIO, or CHECKBOX.
boolean
Whether the field is required. Defaults to false if not specified.
string
Default value for the field (for non-choice fields)
string
Instructions or help text for the field
integer
Maximum character limit for text fields
boolean
Whether regular resources can edit this field. Defaults to false if not specified.
string
Placeholder text displayed in the input field
boolean
Allow multiple selections for SELECT fields. Only applicable when type is SELECT.
boolean
Whether choices should be sorted alphabetically. Defaults to true if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_PROJECT_GROUPTool to create a new project group in Hub Planner. Use when you need to organize projects into groups for better management and categorization. Can create top-level groups or subgroups (with parentGroupId, requires Sidebar Pro extension).

Input Parameters

string
required
Group name. This is the display name for the project group and is required for creation.
string
Custom metadata field (max 255 characters). Use this for storing additional custom information about the project group.
string
Parent group ID for creating a subgroup. Requires Sidebar Pro extension. When specified, this group will be created as a child of the specified parent group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_PROJECT_TAGTool to create a new project tag in Hub Planner. Use when you need to add a new tag that can be associated with projects for categorization and organization purposes.

Input Parameters

string
required
Project tag value. This is the display name for the tag and is required for creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_RESOURCETool to create a new resource in Hub Planner. Pass a resource object with firstName (required) and optional fields. Can optionally send an invitation email by setting sendInviteEmail to true (requires email field).

Input Parameters

string
Notes about the resource
string
Role assigned to the resource
string
Resource email address (must be unique). Required if sendInviteEmail is true
Resource links configuration.
string ("STATUS_ACTIVE" | "STATUS_ARCHIVED" | "STATUS_NON_BOOKABLE" | "STATUS_PARKED")
Resource status values.
object
Billing configuration (deprecated).
string
Resource last name
string
Custom metadata field (max 255 characters)
string
required
Resource first name (required)
array
Array of calendar IDs associated with the resource
array
Array of custom field values for the resource
object
Resource billing rates structure.
boolean
Send invitation email to the resource. Requires email field to be set
boolean
Whether the resource is designated as a project manager
boolean
Whether to use custom availability settings for the resource

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_RESOURCE_CUSTOM_FIELD_TEMPLATETool to create a new resource custom field template in Hub Planner. Use when you need to add custom fields to resource profiles (e.g., department, skills, certifications).

Input Parameters

string ("TEXT" | "TEXTAREA" | "EMAIL" | "DATE" | "COLOR" | "NUMBER" | "CHECKBOX" | "SELECT" | "RADIO")
required
Field type: TEXT, TEXTAREA, EMAIL, DATE, COLOR, NUMBER, CHECKBOX, SELECT, or RADIO
string
required
Field label that will be displayed to users
array
Array of choices for SELECT, RADIO, or CHECKBOX field types. Required for these types, ignored for others
boolean
Whether the field is mandatory. Defaults to false if not specified
string
Optional instructions or guidance text for field usage

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_RESOURCE_TAGTool to create a new resource tag in Hub Planner. Use when you need to add a new tag for categorizing or labeling resources.

Input Parameters

string
required
The name/value of the resource tag being created. This is required and is the only field allowed in the request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_TIME_ENTRYTool to create a new time entry for a resource on a project in Hub Planner. Use when you need to log time spent by team members on specific projects with date and duration.

Input Parameters

string
required
Date of the time entry in YYYY-MM-DD format.
string
Optional note or description for the time entry. Use this to add context about the work performed.
integer
required
Duration of the time entry in minutes. For example, 480 minutes equals 8 hours.
string
required
Project ID to associate with this time entry. This identifies the project the time is logged against.
string
Custom metadata field (max 255 characters).
string
required
Resource ID to assign the time entry to. This identifies the team member logging the time.
string
Category template ID to categorize the time entry. Use this to classify the type of work performed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_CREATE_VACATIONTool to create a new vacation request for a resource in Hub Planner. Supports approval workflow with configurable approvers and statuses. Use when you need to create time-off requests for team members.

Input Parameters

string
required
Vacation end date in YYYY-MM-DD format (e.g., ‘2026-03-20’). Can also use hourly format for precise timing.
string ("WAITING_FOR_APPROVAL" | "APPROVED" | "REJECTED")
Vacation status/type. Use WAITING_FOR_APPROVAL for new requests pending approval, APPROVED for pre-approved vacation, or REJECTED for denied requests.
string
required
Vacation start date in YYYY-MM-DD format (e.g., ‘2026-03-15’). Can also use hourly format for precise timing.
string
Title or description for the vacation request (e.g., ‘Annual Leave’, ‘Summer Vacation’).
string
Custom metadata field for additional information.
string
required
Resource ID for whom the vacation is being created. This is the employee/team member requesting vacation.
object
Approval workflow information.
integer
Minutes per day for the vacation. Defaults to 480 (8 hours/full day). Adjust for partial day requests.
number
Allocation percentage for the vacation. Defaults to 100 (full day). Use lower values for partial day vacations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_BILLING_RATETool to delete a specific billing rate by ID in Hub Planner. Use when you need to permanently remove a billing rate.

Input Parameters

string
required
Billing rate ID to delete. Must be a valid Hub Planner billing rate identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_BOOKINGTool to delete a specific booking by ID in Hub Planner. Use when you need to permanently remove a booking.

Input Parameters

string
required
Booking ID to delete. Must be a valid Hub Planner booking identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_BOOKINGSDelete Hub Planner bookings by booking IDs, resource ID, or project ID. Returned booking IDs may reflect the requested IDs rather than individually confirmed deletions; resource- or project-only deletions may return an empty ID list.

Input Parameters

string
Comma-separated booking IDs to delete. Example: ‘693ed5dad8729e5dc0c812fc,693ed5dad8729e5dc0c812fd’. Use this to delete specific bookings by their IDs.
string
Project ID to delete all associated bookings. When provided, all bookings under this project will be deleted.
string
Resource ID to delete all associated bookings. When provided, all bookings assigned to this resource will be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_CLIENTTool to delete a specific client by ID in Hub Planner. Use when you need to permanently remove a client organization.

Input Parameters

string
required
Client ID to delete. Must be a valid Hub Planner client identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_COST_CATEGORYTool to delete a specific project cost category by ID in Hub Planner. Use when you need to permanently remove a cost category.

Input Parameters

string
required
Cost category ID to delete. Must be a valid Hub Planner cost category identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_EVENTTool to delete a specific event by ID in Hub Planner. Use when you need to permanently remove an event.

Input Parameters

string
required
Event ID to delete. Must be a valid Hub Planner event identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_HOLIDAYTool to delete a specific holiday by ID in Hub Planner. Use when you need to permanently remove a holiday.

Input Parameters

string
required
Holiday ID to delete. Must be a valid Hub Planner holiday identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_MILESTONETool to delete a specific milestone by ID in Hub Planner. Use when you need to permanently remove a milestone.

Input Parameters

string
required
Milestone ID to delete. Must be a valid Hub Planner milestone identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_PROJECTTool to delete a specific project by ID in Hub Planner. Use when you need to permanently remove a project.

Input Parameters

string
required
Project ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_PROJECT_CUSTOM_FIELD_TEMPLATETool to delete a project custom field template by its ID. Use when you need to remove a custom field template from the project configuration.

Input Parameters

string
required
The unique identifier of the project custom field template to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_PROJECT_GROUPTool to delete a specific project group by ID in Hub Planner. Use when you need to permanently remove a project group.

Input Parameters

string
required
Project group ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_PROJECTSDelete one or more Hub Planner projects by ID in a single request. At least one project ID is required.

Input Parameters

array
required
Array of project IDs to delete. Each ID should be a valid project identifier from Hub Planner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_PROJECT_TAGTool to delete a specific project tag by ID in Hub Planner. Use when you need to permanently remove a project tag from the system.

Input Parameters

string
required
The unique identifier of the project tag to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_RESOURCETool to delete a specific resource by ID. Use when you need to remove a resource from Hub Planner.

Input Parameters

string
required
Resource ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_RESOURCE_CUSTOM_FIELD_TEMPLATETool to delete a specific resource custom field template by ID. Use when permanently removing a custom field template after confirming the correct template ID.

Input Parameters

string
required
The unique identifier of the custom field template to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_RESOURCESTool to delete multiple resources by their IDs in a single operation. Use when you need to remove multiple resources from Hub Planner.

Input Parameters

array
required
Array of resource IDs to delete. Each ID should be a valid resource identifier from Hub Planner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_RESOURCE_TAGTool to delete a specific resource tag by ID in Hub Planner. Use when you need to permanently remove a resource tag from the system.

Input Parameters

string
required
The unique identifier of the resource tag to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_TIME_ENTRIESTool to delete multiple time entries by their IDs in a single operation. Use when you need to remove multiple time entries from Hub Planner timesheets.

Input Parameters

array
required
Array of time entry IDs to delete. Each ID should be a valid time entry identifier from Hub Planner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_TIME_ENTRYTool to delete a specific time entry by ID in Hub Planner. Use when you need to permanently remove a time entry.

Input Parameters

string
required
Time entry ID to delete. Must be a valid Hub Planner time entry identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_DELETE_VACATIONTool to delete a specific vacation by ID in Hub Planner. Use when you need to permanently remove a vacation.

Input Parameters

string
required
Vacation ID to delete. Must be a valid Hub Planner vacation identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_BILLING_RATETool to retrieve a specific billing rate by ID from Hub Planner. Use when you need to fetch detailed information about a billing rate including its label, currency, and rate amount.

Input Parameters

string
required
Billing rate ID to retrieve. Must be a valid Hub Planner billing rate identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_BOOKINGTool to retrieve a specific booking by ID from Hub Planner. Use when you need to fetch detailed information about a specific booking including resource assignments, project associations, dates, approval state, and billing rates.

Input Parameters

string
required
Booking ID to retrieve. Must be a valid Hub Planner booking identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_BOOKING_CATEGORYTool to retrieve a specific booking category by ID from Hub Planner. Use when you need to fetch detailed information about a booking category including its name, color, type, and group associations.

Input Parameters

string
required
Category ID to retrieve. Must be a valid Hub Planner booking category identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_CLIENTTool to retrieve a specific client by ID from Hub Planner. Use when you need to fetch detailed information about a client organization.

Input Parameters

string
required
Client ID to retrieve. Must be a valid Hub Planner client identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_COST_CATEGORYTool to retrieve a specific project cost category by ID from Hub Planner. Returns the cost category object including name and timestamps. Use when you need detailed information about a specific project cost category.

Input Parameters

string
required
Cost category ID - a unique identifier for the project cost category (e.g., ‘693ed57b314420f795cacde8’). This is required to retrieve the specific cost category details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_EVENTTool to retrieve a specific event by ID from Hub Planner. Use when you need to fetch detailed information about a specific event including its name, code, dates, and color settings.

Input Parameters

string
required
Event ID to retrieve. Must be a valid Hub Planner event identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_HOLIDAYTool to retrieve a specific holiday by ID from Hub Planner. Use when you need to fetch detailed information about a specific holiday including its name, date, color, and repeat settings.

Input Parameters

string
required
Holiday ID to retrieve. Must be a valid Hub Planner holiday identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_MILESTONETool to retrieve a specific milestone by ID from Hub Planner. Returns the milestone details including name, date, project reference, and metadata. Use when you need information about a specific project milestone.

Input Parameters

string
required
Milestone ID - a unique identifier for the milestone (e.g., ‘698dca3d81fa9038629a2eea’). This is required to retrieve the specific milestone details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_PROJECTRetrieve a specific project by ID from Hub Planner. Returns project details including name, status, resources, budget, custom fields, and tags.

Input Parameters

string
required
Project ID - a unique identifier for the project (e.g., ‘693ed5dad8729e5dc0c811a3’). This is required to retrieve the specific project details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_PROJECT_CUSTOM_FIELD_TEMPLATETool to retrieve a specific project custom field template by ID. Use when you need to get details about a particular project custom field configuration.

Input Parameters

string
required
Custom field template ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_PROJECT_CUSTOM_FIELD_TEMPLATESTool to retrieve all project custom field templates defined for your Hub Planner account. Use when you need to see available custom field configurations that can be applied to projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_PROJECT_GROUPTool to retrieve a specific project group by ID from Hub Planner. Returns the project group object including name, associated project IDs, and metadata. Use when you need detailed information about a specific project group.

Input Parameters

string
required
Project group ID - a unique identifier for the project group (e.g., ‘53a168304cc0f1bb16a898ca’). This is required to retrieve the specific project group details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_PROJECT_TAGSTool to retrieve all tags associated with a specific Hub Planner project. Use when you need to view the current tags on a project.

Input Parameters

string
required
The unique identifier of the project to retrieve tags for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_RESOURCETool to retrieve a specific resource by ID from Hub Planner. Use when you need to fetch detailed information about a team member or resource.

Input Parameters

string
required
Resource ID to retrieve. Must be a valid Hub Planner resource identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_RESOURCE_CUSTOM_FIELD_TEMPLATETool to retrieve a specific resource custom field template by ID from Hub Planner. Use when you need to fetch detailed configuration and schema information about a custom field template.

Input Parameters

string
required
Custom field template ID to retrieve. Must be a valid Hub Planner custom field template identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_RESOURCE_CUSTOM_FIELD_TEMPLATESTool to retrieve custom field templates defined for resources in your Hub Planner account. Use when you need to understand available custom fields, their types, validation rules, and configuration options for resources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_RESOURCE_TAGSRetrieve the tags associated with a specific Hub Planner resource by its ID, including tag IDs, values, and categories.

Input Parameters

string
required
The unique identifier of the resource to retrieve tags for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_TIME_ENTRYTool to retrieve a specific time entry by ID from Hub Planner. Use when you need to fetch detailed information about a logged time entry including project details, duration, status, and approval state.

Input Parameters

string
required
Time entry ID to retrieve. Must be a valid Hub Planner time entry identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_GET_VACATIONTool to retrieve a specific vacation by ID from Hub Planner. Use when you need to fetch detailed information about a vacation request including approval status, dates, resource assignment, and approval notes.

Input Parameters

string
required
Vacation ID to retrieve. Must be a valid Hub Planner vacation identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_BILLING_RATESList billing rates in Hub Planner, with optional pagination. Returns billing rate objects with details such as label, currency, rate amount, and metadata.

Input Parameters

integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of results to return per page. Maximum value is 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_BOOKING_CATEGORIESTool to retrieve all booking categories from Hub Planner. Returns an array of category objects including name, color, type, and group associations. Use when you need to list available booking categories for scheduling or filtering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_BOOKINGSList Hub Planner bookings with pagination support, including resource assignments, project associations, dates, approval states, and billing rates. Without a limit, the API returns 20 bookings by default; retrieve additional pages to obtain more.

Input Parameters

integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of results to return per page. Default is 20, maximum is 1000.
boolean
Set to true to include deleted bookings in the results. By default, only active bookings are returned.
boolean
Set to true to include booking dependencies in the response. Dependencies show relationships between bookings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_CATEGORY_GROUPSTool to get all category groups from Hub Planner. Returns an array of category group objects with group name, type, and associated category IDs. Use when you need to retrieve booking category groups. Note that CUSTOM groups require the Booking Category Groups extension.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_CLIENTSTool to get all clients from Hub Planner. Returns an array of client objects with details including name and creation date. Use when you need to retrieve the complete list of clients with optional pagination.

Input Parameters

integer
Page number for pagination. Use in conjunction with limit parameter.
integer
Maximum number of results to return. Max value is 1000. Default is 0 (unlimited).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_COST_CATEGORIESTool to retrieve all project cost categories from Hub Planner. Returns an array of cost category objects with details including name and timestamps. Use when you need to list all available cost categories for projects in your organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_EVENTSTool to retrieve all events from Hub Planner. Events work like projects but are used for non-project activities. Returns an array of event objects with details including name, event code, and custom metadata. Use when you need to list events with optional pagination and sorting.

Input Parameters

integer
Page number for pagination, starting at 0
string
Sort field with optional - prefix for descending order (e.g., ‘name’ for ascending, ‘-createdDate’ for descending)
integer
Maximum number of results per page (max 1000)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_HOLIDAYSTool to retrieve all public holidays from Hub Planner. Returns an array of holiday objects with details including name, date, color, and recurrence settings. Use when you need to check public holidays or manage holiday schedules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_PROJECT_GROUPSTool to get all project groups from Hub Planner. Returns an array of project group objects with group name, associated project IDs, and metadata. Use when you need to retrieve the complete list of project groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_PROJECT_MANAGERSTool to get all project managers from Hub Planner. Returns an array of project manager objects with details including email, name, status, role, and custom fields. Use when you need to retrieve the complete list of users who have project manager privileges.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_PROJECTSTool to retrieve all projects from Hub Planner. Returns an array of project objects with details including name, status, resources, project managers, budget settings, custom fields, and tags. Use when you need to list projects with optional pagination and sorting.

Input Parameters

integer
Page number for pagination, starting at 0
string
Sort field with optional - prefix for descending order (e.g., ‘name’ for ascending, ‘-createdDate’ for descending)
integer
Maximum number of results per page (max 1000)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_PROJECT_TAGSTool to retrieve all project tags from Hub Planner. Returns an array of project tag objects containing tag ID, value, and category. Use when you need to view all available project tags in the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_RESOURCE_GROUPSTool to get all resource groups from Hub Planner. Returns an array of resource group objects with group name, associated resource IDs, approvers, and metadata. Use when you need to retrieve the complete list of resource groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_RESOURCESTool to get all resources from Hub Planner. Returns an array of resource objects with details including name, email, status, role, billing, and custom fields. Use when you need to retrieve the complete list of resources with optional pagination and sorting.

Input Parameters

integer
Page number for pagination. Use to navigate through multiple pages of results.
string
Field name to sort results by. Examples: ‘firstName’, ‘lastName’, ‘email’, ‘createdDate’.
integer
Maximum number of results per page. Maximum value is 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_RESOURCE_TAGSTool to get all resource tags from Hub Planner. Returns an array of resource tag objects with ID, value, and category. Use when you need to retrieve the complete list of resource tags in the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_TIME_ENTRIESTool to get all time entries from Hub Planner. Returns paginated results with time entry details including resource, project, date, minutes, and status. Use when you need to retrieve time tracking data across projects and resources.

Input Parameters

integer
Page number for pagination. Use to navigate through multiple pages of results.
integer
Maximum number of results per page. Default is 20, maximum is 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_UNASSIGNED_WORKTool to retrieve all unassigned work from Hub Planner. Use when you need to get a list of work items that have not been assigned to any resource. Requires the unassigned work extension to be enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_LIST_VACATIONSList vacations in Hub Planner with optional pagination, returning vacation objects with resource assignments, dates, approval status, and allocation information. Requires the Vacation extension to be enabled.

Input Parameters

integer
Page number for pagination. Use to navigate through multiple pages of results.
integer
Number of results to return per page. Default is 20, maximum is 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_PATCH_BOOKINGTool to partially update an existing booking in Hub Planner. Unlike PUT, only pass the properties you want to modify. Use when you need to update booking details like dates, notes, state values, or to approve/reject booking requests.

Input Parameters

string
required
Booking ID to patch. Must be a valid Hub Planner booking identifier.
string
Booking end date and time. Format: YYYY-MM-DDTHH:mm
string
Notes or comments for this booking
string
Booking approval type. Use to change the approval state. Possible values: SCHEDULED, APPROVED, WAITING_FOR_APPROVAL, REJECTED
string
Booking start date and time. Format: YYYY-MM-DDTHH:mm
string
Custom field data or additional metadata (maximum 255 characters)
number
Numeric value representing the booking state (percentage, minutes, etc. depending on state type)
object
Approval information for booking approval/rejection.
boolean
Set to true to allow overbooking and override scheduling conflict warnings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_PATCH_VACATIONTool to partially update an existing vacation by ID in Hub Planner. Preferred method over PUT for partial updates. Use when you need to modify specific vacation fields like percentAllocation, title, or approval status without sending the entire vacation object.

Input Parameters

string
required
Vacation ID to update. Must be a valid Hub Planner vacation identifier.
string
End date-time of the vacation in ISO 8601 format. When the vacation ends.
string ("WAITING_FOR_APPROVAL" | "APPROVED" | "REJECTED" | "SCHEDULED")
Vacation type/status enumeration.
string
Start date-time of the vacation in ISO 8601 format. When the vacation begins.
string
Custom state field for additional vacation status information.
string
Vacation title or description. A descriptive name for the vacation.
string
Project ID associated with the vacation, if applicable.
string
Custom metadata field for storing additional information about the vacation.
string
Resource ID (employee/team member) associated with the vacation.
object
Approval information for vacation requests.
integer
Number of vacation minutes per day. Used for partial day vacations.
integer
Percentage allocation for the vacation (0-100). Useful for partial day absences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_REMOVE_CLIENT_FROM_PROJECTSTool to remove a client from one or more projects in Hub Planner. Use when you need to unlink a client from specific projects by providing an array of project IDs.

Input Parameters

string
required
The unique identifier of the client to remove from projects
array
required
Array of project IDs from which to remove the client. Must contain at least one project ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_REMOVE_PROJECT_FROM_GROUPSTool to remove a project from one or more project groups in Hub Planner. Use when you need to unlink a project from specific groups by providing an array of group IDs.

Input Parameters

array
required
Array of project group IDs from which to remove the project. Must contain at least one group ID.
string
required
The unique identifier of the project to remove from groups

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_REMOVE_PROJECT_TAGTool to remove a tag from a Hub Planner project. Use when you need to detach a tag from a specific project.

Input Parameters

string
required
The unique identifier of the tag to remove from the project
string
required
The unique identifier of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_REMOVE_RESOURCE_FROM_PROJECTSTool to remove a resource from one or more projects in Hub Planner. Use when you need to unassign a resource from specific projects by providing the resource ID and an array of project IDs.

Input Parameters

array
required
Array of project IDs from which to remove the resource
string
required
The ID of the resource to remove from projects

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_REMOVE_RESOURCE_TAGTool to remove a tag from a resource. Use when you need to disassociate a specific tag from a resource.

Input Parameters

string
required
The unique identifier of the tag to remove from the resource.
string
required
The unique identifier of the resource from which to remove the tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_BILLING_RATESTool to search billing rates in Hub Planner with filters. Supports filtering by currency, label, rate amount, and metadata. Use when you need to find billing rates matching specific criteria.

Input Parameters

number
Filter by billing rate amount. Exact match filter for the numeric rate value.
string
Filter by billing rate label/name. Exact match filter.
string
Filter by currency code (e.g., USD, EUR, GBP). Exact match filter.
string
Filter by custom metadata field (max 255 characters). Exact match filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_BOOKING_CATEGORIESTool to search booking categories in Hub Planner with filters. Use when you need to find booking categories by type, name, or category group. Supports filtering by NON_OPTIONAL/CUSTOM types and partial name matching.

Input Parameters

string
Filter by category name. Supports partial string matching (includes). Use to find categories with names containing this string.
integer
Page number for pagination. Use to navigate through multiple pages of results.
string
Filter by category type. Valid values: NON_OPTIONAL (default type) or CUSTOM. Use to find categories of a specific type.
string
Filter by category group ID. Use to find all categories belonging to a specific category group.
integer
Number of results to return per page. Default is 20, maximum is 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_BOOKINGSSearch Hub Planner bookings by resource, project, dates, metadata, deletion status, and other criteria. Use inclusion, exclusion, and date comparison filters to find matching bookings, with page and limit options for navigating results.

Input Parameters

object
Filter operator for booking search fields supporting MongoDB-style operators.
string
Filter by end date. Can be a date string (YYYY-MM-DD) or an operator object with date comparison operators ($lt, $lte, $gte, $gt).
integer
Page number for pagination. Use to navigate through multiple pages of results.
integer
Number of results to return per page. Default is 20, maximum is 1000.
string
Filter by start date. Can be a date string (YYYY-MM-DD) or an operator object with date comparison operators ($lt, $lte, $gte, $gt).
boolean
Set to true to retrieve only deleted bookings. Set to false or omit to retrieve active bookings.
string
Filter by project ID. Can be a single ID string or an operator object with $in/$nin arrays.
string
Filter by custom metadata field (max 255 characters). Can be a string value or an operator object.
string
Filter by resource ID. Can be a single ID string or an operator object with $in/$nin arrays.
object
Filter operator for booking search fields supporting MongoDB-style operators.
object
Filter operator for booking search fields supporting MongoDB-style operators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_CLIENTSTool to search clients with filters in Hub Planner. Use when you need to find clients based on name or metadata. Supports operators like $in, $nin, and $like for flexible filtering.

Input Parameters

string
Client name filter. Use string for exact match or object with $in/$nin/$like operators. Example: ‘Acme Corp’ or {‘$like’: ‘Acme’}
integer
Page number for pagination. Use to navigate through multiple pages of results.
integer
Number of results to return per page. Default is 20, maximum is 1000.
string
Client metadata filter. Use string for exact match or object with $in/$nin/$like operators. Example: ‘custom-value’ or {‘$like’: ‘meta’}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_COST_CATEGORIESSearch Hub Planner project cost categories by ID or name. Use exact values or inclusion and exclusion filters to find matching categories, with page and limit options for navigating results.

Input Parameters

string
Cost category ID filter. Use string for exact match or object with $in/$nin for multiple values. Example: ‘5f057949f338cd432a794a12’ or {‘$in’: [‘id1’, ‘id2’]}
string
Cost category name filter. Use string for exact match or object with $in/$nin operators. Example: ‘Office’ or {‘$in’: [‘Office’, ‘Travel’]}
integer
Page number for pagination. Use to navigate through multiple pages of results.
integer
Number of results to return per page. Default is 20, maximum is 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_EVENTSTool to search events with filters in Hub Planner. Use when you need to find events based on name, event code, resources, or custom metadata. Supports operators like $in and $nin for flexible filtering.

Input Parameters

string
Event ID filter. Use string for exact match or object with $in/$nin for multiple values
string
Event name filter. Use string for exact match or object with $in/$nin operators
integer
Page number for pagination. Use to navigate through multiple pages of results.
integer
Number of results to return per page. Default is 20, maximum is 1000.
string
Metadata filter. Use string for exact match or object with $in/$nin operators
string
Event code filter. Use string for exact match or object with $in/$nin operators
string
Resource ID filter. Use string for exact match or object with $in/$nin operators to filter events by associated resources

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_HOLIDAYSTool to search holidays with filters in Hub Planner. Use when you need to find holidays based on name, date range, or metadata. Supports operators like $in, $nin, $lt, $lte, and $gte for flexible filtering.

Input Parameters

string
Holiday ID filter. Use string for exact match or object with $in/$nin for multiple values
object
Holiday date filter using comparison operators. Use $lt, $lte, or $gte with date in YYYY-MM-DD format
string
Holiday name filter. Use string for exact match or object with $in/$nin operators
string
Holiday metadata filter. Use string for exact match or object with $in/$nin operators

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_MILESTONESTool to search milestones in Hub Planner with filters. Supports filtering by project, date, name, and metadata using MongoDB-style operators ($in, $nin, $lt, $lte, $gte). Use when you need to find milestones matching specific criteria or date ranges.

Input Parameters

object
Filter operator for milestone search fields supporting MongoDB-style operators.
string
Filter by milestone date. Can be a date string (YYYY-MM-DD) or an operator object with date comparison operators ($lt, $lte, $gte).
string
Filter by milestone name. Can be a string for exact match or an operator object with $in/$nin arrays.
integer
Page number for pagination. Use to navigate through multiple pages of results.
integer
Number of results to return per page. Default is 20, maximum is 1000.
string
Filter by project ID. Can be a single ID string or an operator object with $in/$nin arrays.
string
Filter by custom metadata field. Can be a string value or an operator object with $in/$nin arrays.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_PROJECT_CUSTOM_FIELDSTool to search project custom field templates by type, label, or required status. Use when you need to find specific custom fields or retrieve all project custom field templates.

Input Parameters

string ("TEXT" | "TEXTAREA" | "EMAIL" | "DATE" | "COLOR" | "NUMBER" | "CHECKBOX" | "SELECT" | "RADIO")
Enum for custom field types in Hub Planner.
string
Filter by custom field label. Supports search operators like $in, $nin, $like for advanced filtering.
boolean
Filter by whether the field is required. Set to true for required fields, false for optional fields, or omit to return all.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_PROJECTSTool to search projects with filters in Hub Planner. Use when you need to find projects based on status, name, project code, resources, dates, or custom fields. Supports operators like $in, $nin, $lt, $lte, $gte, and $like for flexible filtering.

Input Parameters

string
Project ID filter. Use string for exact match or object with $in/$nin for multiple values. Example: ‘507f1f77bcf86cd799439011’ or {‘$in’: [‘id1’, ‘id2’]}
object
Project end date filter using comparison operators. Use $lt, $lte, or $gte with date in YYYY-MM-DD format. Example: {‘$lte’: ‘2024-12-31’} or {‘$gte’: ‘2024-06-01’}
string
Project name filter. Use string for exact match or object with $in/$nin/$like operators. Example: ‘My Project’ or {‘$like’: ‘Project’}
integer
Page number for pagination. Use to navigate through multiple pages of results.
integer
Number of results to return per page. Default is 20, maximum is 1000.
object
Project start date filter using comparison operators. Use $lt, $lte, or $gte with date in YYYY-MM-DD format. Example: {‘$gte’: ‘2024-01-01’} or {‘$lt’: ‘2024-12-31’}
string
Project status filter. Use string for exact match or object with $in/$nin. Valid statuses: STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_PENDING, STATUS_PLANNED, STATUS_FLOATING. Example: ‘STATUS_ACTIVE’ or {‘$in’: [‘STATUS_ACTIVE’, ‘STATUS_PENDING’]}
string
Project metadata filter. Use string for exact match or object with $in/$nin operators. Example: ‘custom-value’ or {‘$like’: ‘meta’}
string
Resource ID filter. Use string for exact match or object with $in/$nin operators. Example: ‘507f1f77bcf86cd799439011’ or {‘$in’: [‘res1’, ‘res2’]}
string
Project code filter. Use string for exact match or object with $in/$nin operators. Example: ‘PROJ-001’ or {‘$nin’: [‘PROJ-999’]}
string
Custom field value filter. Use string for exact match or object with $in/$nin/$like operators. Example: ‘High’ or {‘$like’: ‘Complete’}
string
Custom field template ID filter. Use string for exact match or object with $in/$nin operators. Example: ‘template123’ or {‘$in’: [‘template1’, ‘template2’]}
string
Custom field template label filter. Use string for exact match or object with $in/$nin/$like operators. Example: ‘Priority’ or {‘$like’: ‘Status’}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_RESOURCE_CUSTOM_FIELD_TEMPLATESTool to search resource custom field templates by type, label, or other properties. Use when you need to find specific custom field templates defined for resources in Hub Planner.

Input Parameters

string ("TEXT" | "TEXTAREA" | "EMAIL" | "DATE" | "COLOR" | "NUMBER" | "CHECKBOX" | "SELECT" | "RADIO")
Filter templates by custom field type (TEXT, TEXTAREA, EMAIL, DATE, COLOR, NUMBER, CHECKBOX, SELECT, RADIO).
string
Filter templates by label (name of the custom field).
boolean
Filter templates by whether the field is required or optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_RESOURCESSearch Hub Planner resources by status, name, email, or role, with optional pagination.

Input Parameters

integer
Page number for pagination. Use to navigate through multiple pages of results.
string
Filter resources by their role in the organization.
string
Filter resources by email address. Typically performs exact match.
integer
Number of results to return per page. Default is 20, maximum is 1000.
string
Filter resources by status. Common values include STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_NON_BOOKABLE, STATUS_PARKED.
string
Filter resources by last name. Supports exact match or partial match depending on API implementation.
string
Filter resources by first name. Supports exact match or partial match depending on API implementation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_TIME_ENTRIESTool to search time entries with filters in Hub Planner. Use when you need to find time entries based on resource, project, date range, or status. Supports operators like $in, $nin, $lt, $lte, $gt, $gte for flexible filtering.

Input Parameters

object
Date filter using comparison operators. Use $lt, $lte, $gt, $gte with date in YYYY-MM-DD format to filter entries by date range
integer
Page number for pagination. Use to navigate through multiple pages of results.
integer
Number of results to return per page. Default is 20, maximum is 1000.
string
Status filter. Use string for exact match or object with $in/$nin operators. Valid statuses: UNSUBMITTED, SUBMITTED, APPROVED, REJECTED, PENDING, EMPTY
string
Project ID filter. Use string for exact match or object with $in/$nin operators to filter by multiple project IDs
string
Resource ID filter. Use string for exact match or object with $in/$nin operators to filter by multiple resource IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SEARCH_VACATIONSTool to search vacations in Hub Planner with advanced filters. Supports filtering by resource, dates, type, title, and metadata using MongoDB-style operators ($in, $nin, $lt, $lte, $gte). Use when you need to find vacations matching specific criteria or date ranges.

Input Parameters

object
Filter operator for vacation search fields supporting MongoDB-style operators.
object
Filter operator for vacation search fields supporting MongoDB-style operators.
integer
Page number for pagination. Use to navigate through multiple pages of results.
string
Filter by vacation type. Can be a single type string or an operator object with $in/$nin arrays. Common types include ‘APPROVED’, ‘REJECTED’, ‘WAITING_FOR_APPROVAL’.
integer
Number of results to return per page. Default is 20, maximum is 1000.
object
Filter operator for vacation search fields supporting MongoDB-style operators.
string
Filter by vacation title. Can be a single title string or an operator object with $in/$nin arrays.
string
Filter by custom metadata field. Can be a string value or an operator object with $in/$nin arrays.
string
Filter by resource ID. Can be a single ID string or an operator object with $in/$nin arrays.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_SET_PROJECT_MANAGERSTool to set project managers for a Hub Planner project. Replaces existing project managers with the provided list. Requires Project Managers Extension to be enabled.

Input Parameters

string
required
The unique identifier of the project to set managers for.
array
required
Array of resource IDs to set as project managers for this project. Pass an empty array to remove all project managers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_BILLING_RATETool to update an existing billing rate by ID in Hub Planner. Must pass the entire billing rate object with all required fields (_id, rate, label, currency). Use when you need to modify billing rate properties such as rate amount, label, currency, or metadata.

Input Parameters

string
required
Billing rate ID (must match billing_rate_id parameter). Required in the request body for update.
number
required
Billing rate amount. The numeric value representing the billing rate.
string
required
The name of billing rate. A descriptive label for this rate.
string
required
Currency code (e.g., USD, EUR, GBP). Must be a valid 3-letter ISO currency code.
string
Custom metadata field (max 255 characters). Use for storing additional information about the billing rate.
string
Creation timestamp in ISO 8601 format. Typically set by the system on creation.
string
Last update timestamp in ISO 8601 format. Updated automatically by the system.
string
required
Billing rate ID to update. Must be a valid Hub Planner billing rate identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_BOOKINGUpdate an existing booking by ID in Hub Planner, including dates, resources, projects, state values, or notes. The required booking type is SCHEDULED, and the request requires the booking’s required fields.

Input Parameters

string
required
Booking ID (must match booking_id)
string
required
End date/time in ISO format (e.g., 2025-12-12T18:00)
string
Booking notes or description
string ("SCHEDULED")
required
Booking type (typically SCHEDULED)
string
required
Scale type (e.g., SCALE_DAY, SCALE_HOUR)
string
required
Start date/time in ISO format (e.g., 2025-12-08T09:00)
string
required
State type (e.g., STATE_PERCENTAGE, STATE_CONFIRMED)
string
Booking title
boolean
required
Whether booking spans all day
boolean
Whether the booking repeats
object
Booking details with work days and minutes.
string
required
Project ID this booking is associated with
boolean
Whether the booking is billable (can be null)
string
Repeat interval (e.g., NONE, DAILY, WEEKLY)
string
Additional metadata (max 255 characters)
string
required
Resource ID assigned to this booking
string
required
Booking ID to update
number
required
State value representing percentage (0-100) or hours depending on state type
object
Booking rates for external and internal.
string
Creation date in ISO format
string
Last update date in ISO format (can be null)
string
required
Category name
array
Array of custom field objects
string
Deadline name (can be null)
string
Background color for the booking (hex or color name)
string
required
ID of the user who created the booking
string
required
Category template ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_BOOKING_CATEGORYUpdate an existing booking category by ID in Hub Planner, including its name, color, or type. A category type is required and is always included in the update.

Input Parameters

string
required
Category ID to update
string
Category name - the updated name for the booking category
string ("CUSTOM" | "NON_OPTIONAL")
required
Category type - either CUSTOM or NON_OPTIONAL. This field is required.
string
Category color in hex format (e.g., #DB6060) for calendar/grid display

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_CLIENTTool to update an existing client by ID in Hub Planner. Only the name property can be updated. Use when you need to rename a client organization.

Input Parameters

string
required
Client ID to update. Must be a valid Hub Planner client identifier.
string
required
Updated name for the client. This is the only property that can be updated for a client.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_COST_CATEGORYTool to update an existing project cost category by ID in Hub Planner. Updates the name of the cost category. Use when you need to rename or modify a project cost category used for tracking expenses.

Input Parameters

string
required
Cost category ID to update. Must be a valid Hub Planner cost category identifier.
string
required
Updated name for the cost category. This is the primary property for categorizing project costs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_EVENTUpdate an existing Hub Planner event by ID. A name is required; optional properties include status, resources, budget details, colors, and notes.

Input Parameters

string
Event ID (must match event_id). This field is included in the API payload.
string
required
Event name. This is the display name for the event and is required.
string
Event notes or additional description
Event links with icons.
string
Event status (e.g., STATUS_ACTIVE, STATUS_INACTIVE)
string
required
Event ID to update. Must be a valid Hub Planner event identifier.
string
Custom metadata field (maximum 255 characters)
string
Unique event code identifier. Must be unique across all events.
array
Array of resource IDs assigned to this event
number
Total budget hours for the event
string
ISO 8601 timestamp when the event was created (auto-populated by API)
string
ISO 8601 timestamp when the event was last updated (auto-populated by API)
array
Array of custom field objects with flexible key-value structure
string
Currency code for the budget (e.g., USD, EUR)
string
Event background color as hex code (e.g., ‘#349E71’)
number
Total budget cash amount for the event
array
Array of budget category objects with hours and amounts

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_HOLIDAYUpdate an existing holiday by ID in Hub Planner. The update requires the holiday ID, name, and date, and can include color, metadata, and recurrence settings.

Input Parameters

string
required
Holiday ID (must match holiday_id parameter). Required in the request body for update.
string
required
Holiday date in YYYY-MM-DD format. The date when the holiday occurs.
string
required
Holiday name. A descriptive name for the holiday.
string
Hex color code for the holiday display (e.g., #0070c0, #ff0000). Used in calendar views.
boolean
Whether the holiday repeats annually. Set to true for recurring holidays like Christmas or New Year.
string
Custom metadata field (max 255 characters). Use for storing additional information about the holiday.
string
required
Holiday ID to update. Must be a valid Hub Planner holiday identifier.
string
Creation timestamp in ISO 8601 format. Typically set by the system on creation.
string
Last update timestamp in ISO 8601 format. Updated automatically by the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_MILESTONETool to update an existing milestone by ID in Hub Planner. Must pass the entire milestone object with all required fields (_id, name, date, project). Use when you need to modify milestone properties such as name, date, project association, or metadata.

Input Parameters

string
required
Milestone ID (must match milestone_id parameter). Required in the request body for update.
string
required
Milestone date in YYYY-MM-DD format. The date when the milestone is due.
string
required
Milestone name. A descriptive name for the milestone.
string
required
Project ID reference. The project this milestone belongs to.
string
Custom metadata field (max 255 characters). Use for storing additional information about the milestone.
string
required
Milestone ID to update. Must be a valid Hub Planner milestone identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_PROJECT_CUSTOM_FIELD_TEMPLATETool to update an existing project custom field template in Hub Planner. Use when you need to modify field properties like label, type, instructions, or choices.

Input Parameters

string
Custom field template ID (must match template_id)
string ("TEXT" | "TEXTAREA" | "NUMBER" | "DATE" | "SELECT" | "RADIO" | "CHECKBOX")
Field type enum for custom field templates.
string
Field label/name displayed to users
string ("ACTIVE" | "INACTIVE")
Field status enum for custom field templates.
array
Array of choice options for SELECT/RADIO/CHECKBOX field types
boolean
Whether this field can be used to filter in grid views
boolean
Whether this field is required when creating/editing projects
string
required
ID of the custom field template to update
string
Default value for the field
string
Instructional text to help users fill in the field
integer
Character limit for text-based fields
string
Default radio button ID for RADIO type fields
boolean
Whether resources can edit this field
string
Placeholder text shown in empty field
boolean
Whether multiple values can be selected (for SELECT/CHECKBOX types)
boolean
Whether choices should be sorted alphabetically (for SELECT/RADIO/CHECKBOX types)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_PROJECT_GROUPUpdate a Hub Planner project group by ID, supplying its name and optionally its associated projects, metadata, or parent group. Returns the updated project group object.

Input Parameters

string
required
Project group ID - a unique identifier for the project group to update (e.g., ‘698dca1e81fa9038629a252e’). This is required to identify which project group to update.
string
required
Group name - the updated name for the project group. This field is required.
string
Custom metadata field for storing additional information (maximum 255 characters).
array
Array of Project IDs to associate with this group. Pass an empty array to remove all projects from the group.
string
Parent group ID for creating subgroup hierarchy. Set to null to make this a top-level group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_PROJECTSTool to update one or more projects in Hub Planner. Use when you need to modify project properties such as name, status, budget, or other settings. Supports bulk updates by passing multiple project objects in a single request.

Input Parameters

array
required
Array of project objects to update. Each project must include _id and the properties to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_PROJECT_TAGTool to update an existing project tag by ID in Hub Planner. Use when you need to change the value/name of a project tag. Note that the new value cannot conflict with an existing tag value.

Input Parameters

string
required
Project tag ID to update. Must be a valid Hub Planner project tag identifier.
string
required
New tag value. The updated name/value for this project tag. Cannot be a value that already exists for another tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_RESOURCE_CUSTOM_FIELD_TEMPLATETool to update an existing resource custom field template in Hub Planner. Use when you need to modify field properties like label, type, instructions, or configuration settings.

Input Parameters

string
required
Custom field template ID (must match template_id)
string ("TEXT" | "TEXTAREA" | "EMAIL" | "DATE" | "COLOR" | "NUMBER" | "CHECKBOX" | "SELECT" | "RADIO")
required
Type of the custom field (TEXT, TEXTAREA, EMAIL, DATE, COLOR, NUMBER, CHECKBOX, SELECT, RADIO)
string
required
Display name/label for the custom field
string
Status of the custom field template (e.g., ACTIVE, INACTIVE)
array
Array of choice options for SELECT/RADIO/CHECKBOX field types
boolean
Whether the field is mandatory for resources
string
required
ID of the custom field template to update (used in URL path)
string
Default value for the field
string
Help text or usage instructions for the field
integer
Maximum character limit for text-based fields
boolean
Whether resources can edit this field themselves
string
Placeholder text shown in the input field
boolean
Whether the field allows multiple value selections (for SELECT/CHECKBOX types)
boolean
Whether choice options should be sorted alphabetically

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_RESOURCE_GROUPTool to update an existing resource group by ID in Hub Planner. Can update the group name, approvers array, and metadata. Use when you need to modify resource group properties or assign approvers to the group.

Input Parameters

string
required
Resource group ID to update
string
Name of the resource group
string
Custom metadata field (maximum 255 characters)
array
Array of approver IDs to assign to the resource group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_RESOURCESTool to update one or more resources in Hub Planner. Pass an array of resource objects with _id and properties to update. Supports bulk updates by providing multiple resource objects. Use when you need to modify resource properties like name, email, status, notes, or custom fields.

Input Parameters

array
required
Array of resource objects to update. Each object must include _id and the properties to update. Supports bulk updates by passing multiple resources

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_RESOURCE_TAGTool to update an existing resource tag by ID in Hub Planner. Use when you need to change the value/name of a resource tag. Note that the new value cannot conflict with an existing tag value.

Input Parameters

string
required
Resource tag ID to update. Must be a valid Hub Planner resource tag identifier.
string
required
New tag value. The updated name/value for this resource tag. Cannot be a value that already exists for another tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_TIME_ENTRYTool to update an existing time entry by ID in Hub Planner. Must pass the entire time entry object with all required fields (resource, project, date, minutes). Use when you need to modify time tracking data such as hours logged, notes, status, or category.

Input Parameters

string
required
Time entry ID to update. Must be a valid Hub Planner time entry identifier.
string
required
Entry date in YYYY-MM-DD format. The date when the time was logged.
string
Optional notes or description for this time entry. Use to provide context about the work completed.
string ("UNSUBMITTED" | "SUBMITTED" | "APPROVED" | "REJECTED" | "PENDING" | "EMPTY")
Valid time entry status values.
number
required
Duration of the time entry in minutes. For example, 480 minutes = 8 hours, 240 minutes = 4 hours.
string
required
Project ID for this time entry. This identifies the project the time was logged against.
string
Custom metadata field (max 255 characters). Use for storing additional information.
string
required
Resource ID associated with this time entry. This identifies the team member who logged the time.
string
Category template identifier. Used to categorize the type of work logged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HUB_PLANNER_UPDATE_VACATIONTool to update an existing vacation by ID in Hub Planner. Use when you need to modify vacation properties such as dates, title, approval status, or allocation. When setting type to APPROVED or REJECTED, you must provide approvalInfo with approvedOrRejectedDate and approvedOrRejectedById.

Input Parameters

string
Vacation end date/time in ISO 8601 format (e.g., 2018-07-26T18:00:00.000Z)
string ("WAITING_FOR_APPROVAL" | "APPROVED" | "REJECTED")
Vacation type enumeration for approval status.
string
Vacation start date/time in ISO 8601 format (e.g., 2018-07-25T09:00:00.000Z)
string
Title or description of the vacation request
string
Custom metadata field (max 255 characters). Use for storing additional information about the vacation.
string
required
Vacation ID to update. Must be a valid Hub Planner vacation identifier.
object
Approval information required when type is APPROVED or REJECTED.
integer
Minutes per day for the vacation. Defaults to 480 (8 hours) if not specified.
integer
Percentage allocation for the vacation (0-100). Defaults to 100 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not