Hub Planner

hub_planner

A Modern and Smart Resource Management, Planning & Scheduling tool with Time Sheets and Powerful Reporting. Ideal for Managing Global Teams of Resources.

Productivity Project Management Web del proveedor

Acciones

122

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (122)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Clients to ProjectHUB_PLANNER_ADD_CLIENTS_TO_PROJECTAcción

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

Parámetros de entrada

client_idsstring[]Obligatorio
Array of client IDs to add to the project
project_idstringObligatorio
Project ID to add clients to

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add project custom field choicesHUB_PLANNER_ADD_PROJECT_CUSTOM_FIELD_CHOICESAcción

Add 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.

Parámetros de entrada

choicesobject[]Obligatorio
List of choice values to add to the custom field template. Each choice must have a 'value' property.
template_idstringObligatorio
The unique identifier of the custom field template to add choices to. Must be a SELECT, RADIO, or CHECKBOX type template.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Projects to GroupHUB_PLANNER_ADD_PROJECTS_TO_GROUPAcción

Tool 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.

Parámetros de entrada

group_idstringObligatorio
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.
project_idsstring[]Obligatorio
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']).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Project TagsHUB_PLANNER_ADD_PROJECT_TAGSAcción

Tool 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.

Parámetros de entrada

tagsstring[]Obligatorio
Array of tag IDs to add to the project. These will be appended to existing tags.
project_idstringObligatorio
The unique identifier of the project to add tags to.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Resource Custom Field ChoicesHUB_PLANNER_ADD_RESOURCE_CUSTOM_FIELD_CHOICESAcción

Tool 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.

Parámetros de entrada

idstringObligatorio
Custom field template ID to add choices to
choicesobject[]Obligatorio
Array of choice objects to add to the custom field template. Each choice must have a value property.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Resources to ProjectHUB_PLANNER_ADD_RESOURCES_TO_PROJECTAcción

Tool to add resources to a project by project ID. Use when you need to associate one or more resources with a specific project.

Parámetros de entrada

project_idstringObligatorio
Project ID to add resources to
resource_idsstring[]Obligatorio
Array of resource IDs to add to the project

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Resources to Resource GroupHUB_PLANNER_ADD_RESOURCES_TO_RESOURCE_GROUPAcción

Tool 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.

Parámetros de entrada

group_idstringObligatorio
Resource group ID to add resources to
resource_idsstring[]Obligatorio
Array of resource IDs to add to the resource group

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Resource TagsHUB_PLANNER_ADD_RESOURCE_TAGSAcción

Tool 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.

Parámetros de entrada

tagsstring[]Obligatorio
Array of tag IDs to add to the resource. New tags will be appended to existing tags without removing any previously assigned tags.
resource_idstringObligatorio
The unique identifier of the resource to add tags to.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Billing RateHUB_PLANNER_CREATE_BILLING_RATEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create BookingHUB_PLANNER_CREATE_BOOKINGAcción

Tool to create a new booking for a resource on a project in Hub Planner. Supports scheduled bookings, booking requests (WAITING_FOR_APPROVAL), and hourly bookings. Use when you need to allocate resources to projects with specific start/end dates and time commitments.

Parámetros de entrada

endstringObligatorio
Booking end date. Use same format as start date (YYYY-MM-DD or YYYY-MM-DD HH:mm).
notestring
Notes or comments about this booking.
typestringenum
Valid booking type values.
SCHEDULEDWAITING_FOR_APPROVALAPPROVEDREJECTED
startstringObligatorio
Booking start date. Use YYYY-MM-DD format for day bookings or YYYY-MM-DD HH:mm format for hourly bookings.
statestringenum
Valid booking state values.
STATE_DAY_MINUTESTATE_PERCENTAGESTATE_TOTAL_MINUTE
titlestring
Custom title for the booking. If not provided, defaults to project name.
allDayboolean
Set to false for hourly bookings (requires start/end with HH:mm format). Omit or set to true for all-day bookings.
repeatboolean
Set to true to create a repeating booking. Requires interval to be specified.
projectstringObligatorio
Project ID to associate with this booking. This identifies the project the resource is being booked on.
intervalstringenum
Valid repeat interval values.
WEEKLYMONTHLYYEARLY
metadatastring
Custom metadata field (max 255 characters)
resourcestringObligatorio
Resource ID to assign to this booking. This identifies the team member or resource being booked.
stateValuenumber
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.
bookingRateobject
Billing rate configuration.
customFieldsobject[]
Array of custom field values for the booking
allowOverscheduleboolean
Set to true to allow booking even if resource is already fully scheduled. Overrides overscheduling warnings.
repeatEndsAfterTimesinteger
Number of times to repeat the booking. Only used when repeat is true.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Booking CategoryHUB_PLANNER_CREATE_BOOKING_CATEGORYAcción

Tool 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").

Parámetros de entrada

namestringObligatorio
Category name. This is the display name for the booking category.
typestringObligatorioenum
Category type. NON_OPTIONAL indicates the default option within the group. CUSTOM indicates a user-defined category. This field is required.
NON_OPTIONALCUSTOM
groupIdstringObligatorio
Category group ID. This identifies the parent group that will contain this booking category.
gridColorstringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ClientHUB_PLANNER_CREATE_CLIENTAcción

Tool to create a new client in Hub Planner. Use when you need to add a new client organization to the system.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Cost CategoryHUB_PLANNER_CREATE_COST_CATEGORYAcción

Tool to create a new project cost category in Hub Planner. Use when you need to add a new cost category for tracking project expenses.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create EventHUB_PLANNER_CREATE_EVENTAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create HolidayHUB_PLANNER_CREATE_HOLIDAYAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create MilestoneHUB_PLANNER_CREATE_MILESTONEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ProjectHUB_PLANNER_CREATE_PROJECTAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Project Custom Field TemplateHUB_PLANNER_CREATE_PROJECT_CUSTOM_FIELD_TEMPLATEAcción

Tool 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.

Parámetros de entrada

typestringObligatorioenum
Field type (TEXT, TEXTAREA, EMAIL, DATE, COLOR, NUMBER, CHECKBOX, SELECT, RADIO)
TEXTTEXTAREAEMAILDATECOLORNUMBERCHECKBOXSELECTRADIO
labelstringObligatorio
Field label or name
statusstringenum
Enum for custom field status.
ACTIVEINACTIVE
choicesobject[]
Available choices for SELECT, RADIO, or CHECKBOX field types. Required when type is SELECT, RADIO, or CHECKBOX.
isRequiredboolean
Whether the field is required. Defaults to false if not specified.
defaultValuestring
Default value for the field (for non-choice fields)
instructionsstring
Instructions or help text for the field
characterLimitinteger
Maximum character limit for text fields
canResourceEditboolean
Whether regular resources can edit this field. Defaults to false if not specified.
placeholderTextstring
Placeholder text displayed in the input field
allowMultipleValuesboolean
Allow multiple selections for SELECT fields. Only applicable when type is SELECT.
isChoicesSortedAlphabeticallyboolean
Whether choices should be sorted alphabetically. Defaults to true if not specified.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Project GroupHUB_PLANNER_CREATE_PROJECT_GROUPAcción

Tool 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).

Parámetros de entrada

namestringObligatorio
Group name. This is the display name for the project group and is required for creation.
metadatastring
Custom metadata field (max 255 characters). Use this for storing additional custom information about the project group.
parentGroupIdstring
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Project TagHUB_PLANNER_CREATE_PROJECT_TAGAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ResourceHUB_PLANNER_CREATE_RESOURCEAcción

Tool 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).

Parámetros de entrada

notestring
Notes about the resource
rolestring
Role assigned to the resource
emailstring
Resource email address (must be unique). Required if sendInviteEmail is true
linksobject
Resource links configuration.
statusstringenum
Resource status values.
STATUS_ACTIVESTATUS_ARCHIVEDSTATUS_NON_BOOKABLESTATUS_PARKED
billingobject
Billing configuration (deprecated).
lastNamestring
Resource last name
metadatastring
Custom metadata field (max 255 characters)
firstNamestringObligatorio
Resource first name (required)
calendarIdsstring[]
Array of calendar IDs associated with the resource
customFieldsobject[]
Array of custom field values for the resource
resourceRatesobject
Resource billing rates structure.
sendInviteEmailboolean
Send invitation email to the resource. Requires email field to be set
isProjectManagerboolean
Whether the resource is designated as a project manager
useCustomAvailabilityboolean
Whether to use custom availability settings for the resource

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Resource Custom Field TemplateHUB_PLANNER_CREATE_RESOURCE_CUSTOM_FIELD_TEMPLATEAcción

Tool 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).

Parámetros de entrada

typestringObligatorioenum
Field type: TEXT, TEXTAREA, EMAIL, DATE, COLOR, NUMBER, CHECKBOX, SELECT, or RADIO
TEXTTEXTAREAEMAILDATECOLORNUMBERCHECKBOXSELECTRADIO
labelstringObligatorio
Field label that will be displayed to users
choicesobject[]
Array of choices for SELECT, RADIO, or CHECKBOX field types. Required for these types, ignored for others
isRequiredboolean
Whether the field is mandatory. Defaults to false if not specified
instructionsstring
Optional instructions or guidance text for field usage

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Resource TagHUB_PLANNER_CREATE_RESOURCE_TAGAcción

Tool to create a new resource tag in Hub Planner. Use when you need to add a new tag for categorizing or labeling resources.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Time EntryHUB_PLANNER_CREATE_TIME_ENTRYAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create VacationHUB_PLANNER_CREATE_VACATIONAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Billing RateHUB_PLANNER_DELETE_BILLING_RATEAcción

Tool to delete a specific billing rate by ID in Hub Planner. Use when you need to permanently remove a billing rate.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete BookingHUB_PLANNER_DELETE_BOOKINGAcción

Tool to delete a specific booking by ID in Hub Planner. Use when you need to permanently remove a booking.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete BookingsHUB_PLANNER_DELETE_BOOKINGSAcción

Tool to delete multiple bookings by IDs, resource ID, or project ID. Use when you need to remove bookings from Hub Planner based on specific criteria.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ClientHUB_PLANNER_DELETE_CLIENTAcción

Tool to delete a specific client by ID in Hub Planner. Use when you need to permanently remove a client organization.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Cost CategoryHUB_PLANNER_DELETE_COST_CATEGORYAcción

Tool to delete a specific project cost category by ID in Hub Planner. Use when you need to permanently remove a cost category.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete EventHUB_PLANNER_DELETE_EVENTAcción

Tool to delete a specific event by ID in Hub Planner. Use when you need to permanently remove an event.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete HolidayHUB_PLANNER_DELETE_HOLIDAYAcción

Tool to delete a specific holiday by ID in Hub Planner. Use when you need to permanently remove a holiday.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete MilestoneHUB_PLANNER_DELETE_MILESTONEAcción

Tool to delete a specific milestone by ID in Hub Planner. Use when you need to permanently remove a milestone.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ProjectHUB_PLANNER_DELETE_PROJECTAcción

Tool to delete a specific project by ID in Hub Planner. Use when you need to permanently remove a project.

Parámetros de entrada

idstringObligatorio
Project ID to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Project Custom Field TemplateHUB_PLANNER_DELETE_PROJECT_CUSTOM_FIELD_TEMPLATEAcción

Tool to delete a project custom field template by its ID. Use when you need to remove a custom field template from the project configuration.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Project GroupHUB_PLANNER_DELETE_PROJECT_GROUPAcción

Tool to delete a specific project group by ID in Hub Planner. Use when you need to permanently remove a project group.

Parámetros de entrada

idstringObligatorio
Project group ID to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ProjectsHUB_PLANNER_DELETE_PROJECTSAcción

Tool to delete multiple projects by their IDs in a single operation. Use when you need to remove multiple projects from Hub Planner.

Parámetros de entrada

project_idsstring[]Obligatorio
Array of project IDs to delete. Each ID should be a valid project identifier from Hub Planner.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Project TagHUB_PLANNER_DELETE_PROJECT_TAGAcción

Tool to delete a specific project tag by ID in Hub Planner. Use when you need to permanently remove a project tag from the system.

Parámetros de entrada

idstringObligatorio
The unique identifier of the project tag to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ResourceHUB_PLANNER_DELETE_RESOURCEAcción

Tool to delete a specific resource by ID. Use when you need to remove a resource from Hub Planner.

Parámetros de entrada

idstringObligatorio
Resource ID to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Resource Custom Field TemplateHUB_PLANNER_DELETE_RESOURCE_CUSTOM_FIELD_TEMPLATEAcción

Tool to delete a specific resource custom field template by ID. Use when permanently removing a custom field template after confirming the correct template ID.

Parámetros de entrada

idstringObligatorio
The unique identifier of the custom field template to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete resourcesHUB_PLANNER_DELETE_RESOURCESAcción

Tool to delete multiple resources by their IDs in a single operation. Use when you need to remove multiple resources from Hub Planner.

Parámetros de entrada

resource_idsstring[]Obligatorio
Array of resource IDs to delete. Each ID should be a valid resource identifier from Hub Planner.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Resource TagHUB_PLANNER_DELETE_RESOURCE_TAGAcción

Tool to delete a specific resource tag by ID in Hub Planner. Use when you need to permanently remove a resource tag from the system.

Parámetros de entrada

idstringObligatorio
The unique identifier of the resource tag to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Time EntriesHUB_PLANNER_DELETE_TIME_ENTRIESAcción

Tool 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.

Parámetros de entrada

time_entry_idsstring[]Obligatorio
Array of time entry IDs to delete. Each ID should be a valid time entry identifier from Hub Planner.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Time EntryHUB_PLANNER_DELETE_TIME_ENTRYAcción

Tool to delete a specific time entry by ID in Hub Planner. Use when you need to permanently remove a time entry.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete VacationHUB_PLANNER_DELETE_VACATIONAcción

Tool to delete a specific vacation by ID in Hub Planner. Use when you need to permanently remove a vacation.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Billing Rate by IDHUB_PLANNER_GET_BILLING_RATEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Booking by IDHUB_PLANNER_GET_BOOKINGAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Booking Category by IDHUB_PLANNER_GET_BOOKING_CATEGORYAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Client by IDHUB_PLANNER_GET_CLIENTAcción

Tool to retrieve a specific client by ID from Hub Planner. Use when you need to fetch detailed information about a client organization.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Cost CategoryHUB_PLANNER_GET_COST_CATEGORYAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Event by IDHUB_PLANNER_GET_EVENTAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Holiday by IDHUB_PLANNER_GET_HOLIDAYAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get MilestoneHUB_PLANNER_GET_MILESTONEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ProjectHUB_PLANNER_GET_PROJECTAcción

Tool to retrieve a specific project by ID from Hub Planner. Returns the full project object including name, status, resources, budget, custom fields, and tags. Use when you need detailed information about a specific project.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project Custom Field TemplateHUB_PLANNER_GET_PROJECT_CUSTOM_FIELD_TEMPLATEAcción

Tool to retrieve a specific project custom field template by ID. Use when you need to get details about a particular project custom field configuration.

Parámetros de entrada

idstringObligatorio
Custom field template ID to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project Custom Field TemplatesHUB_PLANNER_GET_PROJECT_CUSTOM_FIELD_TEMPLATESAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project GroupHUB_PLANNER_GET_PROJECT_GROUPAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project TagsHUB_PLANNER_GET_PROJECT_TAGSAcción

Tool to retrieve all tags associated with a specific Hub Planner project. Use when you need to view the current tags on a project.

Parámetros de entrada

project_idstringObligatorio
The unique identifier of the project to retrieve tags for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Resource by IDHUB_PLANNER_GET_RESOURCEAcción

Tool to retrieve a specific resource by ID from Hub Planner. Use when you need to fetch detailed information about a team member or resource.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Resource Custom Field TemplateHUB_PLANNER_GET_RESOURCE_CUSTOM_FIELD_TEMPLATEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Resource Custom Field TemplatesHUB_PLANNER_GET_RESOURCE_CUSTOM_FIELD_TEMPLATESAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Resource TagsHUB_PLANNER_GET_RESOURCE_TAGSAcción

Tool to retrieve all tags associated with a specific resource from Hub Planner. Returns an array of tag objects containing tag ID, value, and category. Use when you need to view all tags assigned to a resource.

Parámetros de entrada

resource_idstringObligatorio
The unique identifier of the resource to retrieve tags for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Time Entry by IDHUB_PLANNER_GET_TIME_ENTRYAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Vacation by IDHUB_PLANNER_GET_VACATIONAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Billing RatesHUB_PLANNER_LIST_BILLING_RATESAcción

Tool to retrieve all billing rates from Hub Planner. Returns an array of billing rate objects with details including label, currency, rate amount, and metadata. Use when you need to list all available billing rates with optional pagination support.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Booking CategoriesHUB_PLANNER_LIST_BOOKING_CATEGORIESAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List BookingsHUB_PLANNER_LIST_BOOKINGSAcción

Tool to retrieve all bookings from Hub Planner with pagination support. Returns booking details including resource assignments, project associations, dates, approval states, and billing rates. Use when you need to list, search, or analyze bookings across projects and resources.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Category GroupsHUB_PLANNER_LIST_CATEGORY_GROUPSAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ClientsHUB_PLANNER_LIST_CLIENTSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Cost CategoriesHUB_PLANNER_LIST_COST_CATEGORIESAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List EventsHUB_PLANNER_LIST_EVENTSAcción

Tool 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.

Parámetros de entrada

pageinteger
Page number for pagination, starting at 0
sortstring
Sort field with optional - prefix for descending order (e.g., 'name' for ascending, '-createdDate' for descending)
limitinteger
Maximum number of results per page (max 1000)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List HolidaysHUB_PLANNER_LIST_HOLIDAYSAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Project GroupsHUB_PLANNER_LIST_PROJECT_GROUPSAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Project ManagersHUB_PLANNER_LIST_PROJECT_MANAGERSAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ProjectsHUB_PLANNER_LIST_PROJECTSAcción

Tool 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.

Parámetros de entrada

pageinteger
Page number for pagination, starting at 0
sortstring
Sort field with optional - prefix for descending order (e.g., 'name' for ascending, '-createdDate' for descending)
limitinteger
Maximum number of results per page (max 1000)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Project TagsHUB_PLANNER_LIST_PROJECT_TAGSAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource GroupsHUB_PLANNER_LIST_RESOURCE_GROUPSAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ResourcesHUB_PLANNER_LIST_RESOURCESAcción

Tool 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.

Parámetros de entrada

pageinteger
Page number for pagination. Use to navigate through multiple pages of results.
sortstring
Field name to sort results by. Examples: 'firstName', 'lastName', 'email', 'createdDate'.
limitinteger
Maximum number of results per page. Maximum value is 1000.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource TagsHUB_PLANNER_LIST_RESOURCE_TAGSAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Time EntriesHUB_PLANNER_LIST_TIME_ENTRIESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Unassigned WorkHUB_PLANNER_LIST_UNASSIGNED_WORKAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List VacationsHUB_PLANNER_LIST_VACATIONSAcción

Tool to retrieve all vacations from Hub Planner. Requires Vacation extension to be enabled. Returns an array of vacation objects with details including resource assignments, dates, approval status, and allocation information.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Patch BookingHUB_PLANNER_PATCH_BOOKINGAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Patch VacationHUB_PLANNER_PATCH_VACATIONAcción

Tool 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.

Parámetros de entrada

idstringObligatorio
Vacation ID to update. Must be a valid Hub Planner vacation identifier.
endstring
End date-time of the vacation in ISO 8601 format. When the vacation ends.
typestringenum
Vacation type/status enumeration.
WAITING_FOR_APPROVALAPPROVEDREJECTEDSCHEDULED
startstring
Start date-time of the vacation in ISO 8601 format. When the vacation begins.
statestring
Custom state field for additional vacation status information.
titlestring
Vacation title or description. A descriptive name for the vacation.
projectstring
Project ID associated with the vacation, if applicable.
metadatastring
Custom metadata field for storing additional information about the vacation.
resourcestring
Resource ID (employee/team member) associated with the vacation.
approvalInfoobject
Approval information for vacation requests.
minutesPerDayinteger
Number of vacation minutes per day. Used for partial day vacations.
percentAllocationinteger
Percentage allocation for the vacation (0-100). Useful for partial day absences.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Client From ProjectsHUB_PLANNER_REMOVE_CLIENT_FROM_PROJECTSAcción

Tool 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.

Parámetros de entrada

client_idstringObligatorio
The unique identifier of the client to remove from projects
project_idsstring[]Obligatorio
Array of project IDs from which to remove the client. Must contain at least one project ID.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Project From GroupsHUB_PLANNER_REMOVE_PROJECT_FROM_GROUPSAcción

Tool 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.

Parámetros de entrada

group_idsstring[]Obligatorio
Array of project group IDs from which to remove the project. Must contain at least one group ID.
project_idstringObligatorio
The unique identifier of the project to remove from groups

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Project TagHUB_PLANNER_REMOVE_PROJECT_TAGAcción

Tool to remove a tag from a Hub Planner project. Use when you need to detach a tag from a specific project.

Parámetros de entrada

tag_idstringObligatorio
The unique identifier of the tag to remove from the project
project_idstringObligatorio
The unique identifier of the project

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Resource from ProjectsHUB_PLANNER_REMOVE_RESOURCE_FROM_PROJECTSAcción

Tool 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.

Parámetros de entrada

project_idsstring[]Obligatorio
Array of project IDs from which to remove the resource
resource_idstringObligatorio
The ID of the resource to remove from projects

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Resource TagHUB_PLANNER_REMOVE_RESOURCE_TAGAcción

Tool to remove a tag from a resource. Use when you need to disassociate a specific tag from a resource.

Parámetros de entrada

tag_idstringObligatorio
The unique identifier of the tag to remove from the resource.
resource_idstringObligatorio
The unique identifier of the resource from which to remove the tag.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Billing RatesHUB_PLANNER_SEARCH_BILLING_RATESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Booking CategoriesHUB_PLANNER_SEARCH_BOOKING_CATEGORIESAcción

Tool 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.

Parámetros de entrada

namestring
Filter by category name. Supports partial string matching (includes). Use to find categories with names containing this string.
typestring
Filter by category type. Valid values: NON_OPTIONAL (default type) or CUSTOM. Use to find categories of a specific type.
groupstring
Filter by category group ID. Use to find all categories belonging to a specific category group.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search BookingsHUB_PLANNER_SEARCH_BOOKINGSAcción

Tool to search bookings in Hub Planner with advanced filters. Supports filtering by resource, project, dates, metadata, and more using MongoDB-style operators ($in, $nin, $lt, $lte, $gte, $gt). Use when you need to find bookings matching specific criteria or date ranges.

Parámetros de entrada

_idobject
Filter operator for booking search fields supporting MongoDB-style operators.
endany
Filter by end date. Can be a date string (YYYY-MM-DD) or an operator object with date comparison operators ($lt, $lte, $gte, $gt).
startany
Filter by start date. Can be a date string (YYYY-MM-DD) or an operator object with date comparison operators ($lt, $lte, $gte, $gt).
deletedboolean
Set to true to retrieve only deleted bookings. Set to false or omit to retrieve active bookings.
projectany
Filter by project ID. Can be a single ID string or an operator object with $in/$nin arrays.
metadataany
Filter by custom metadata field (max 255 characters). Can be a string value or an operator object.
resourceany
Filter by resource ID. Can be a single ID string or an operator object with $in/$nin arrays.
deletedDateobject
Filter operator for booking search fields supporting MongoDB-style operators.
updatedDateobject
Filter operator for booking search fields supporting MongoDB-style operators.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search ClientsHUB_PLANNER_SEARCH_CLIENTSAcción

Tool 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.

Parámetros de entrada

nameany
Client name filter. Use string for exact match or object with $in/$nin/$like operators. Example: 'Acme Corp' or {'$like': 'Acme'}
metadataany
Client metadata filter. Use string for exact match or object with $in/$nin/$like operators. Example: 'custom-value' or {'$like': 'meta'}

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Cost CategoriesHUB_PLANNER_SEARCH_COST_CATEGORIESAcción

Tool to search project cost categories in Hub Planner with filters. Use when you need to find cost categories based on ID or name. Supports MongoDB-style operators like $in and $nin for flexible filtering.

Parámetros de entrada

_idany
Cost category ID filter. Use string for exact match or object with $in/$nin for multiple values. Example: '5f057949f338cd432a794a12' or {'$in': ['id1', 'id2']}
nameany
Cost category name filter. Use string for exact match or object with $in/$nin operators. Example: 'Office' or {'$in': ['Office', 'Travel']}

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search EventsHUB_PLANNER_SEARCH_EVENTSAcción

Tool 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.

Parámetros de entrada

_idany
Event ID filter. Use string for exact match or object with $in/$nin for multiple values
nameany
Event name filter. Use string for exact match or object with $in/$nin operators
metadataany
Metadata filter. Use string for exact match or object with $in/$nin operators
eventCodeany
Event code filter. Use string for exact match or object with $in/$nin operators
resourcesany
Resource ID filter. Use string for exact match or object with $in/$nin operators to filter events by associated resources

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search HolidaysHUB_PLANNER_SEARCH_HOLIDAYSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search MilestonesHUB_PLANNER_SEARCH_MILESTONESAcción

Tool 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.

Parámetros de entrada

_idobject
Filter operator for milestone search fields supporting MongoDB-style operators.
dateany
Filter by milestone date. Can be a date string (YYYY-MM-DD) or an operator object with date comparison operators ($lt, $lte, $gte).
nameany
Filter by milestone name. Can be a string for exact match or an operator object with $in/$nin arrays.
projectany
Filter by project ID. Can be a single ID string or an operator object with $in/$nin arrays.
metadataany
Filter by custom metadata field. Can be a string value or an operator object with $in/$nin arrays.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Project Custom FieldsHUB_PLANNER_SEARCH_PROJECT_CUSTOM_FIELDSAcción

Tool 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.

Parámetros de entrada

typestringenum
Enum for custom field types in Hub Planner.
TEXTTEXTAREAEMAILDATECOLORNUMBERCHECKBOXSELECTRADIO
labelstring
Filter by custom field label. Supports search operators like $in, $nin, $like for advanced filtering.
isRequiredboolean
Filter by whether the field is required. Set to true for required fields, false for optional fields, or omit to return all.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search ProjectsHUB_PLANNER_SEARCH_PROJECTSAcción

Tool 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.

Parámetros de entrada

_idany
Project ID filter. Use string for exact match or object with $in/$nin for multiple values. Example: '507f1f77bcf86cd799439011' or {'$in': ['id1', 'id2']}
endobject
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'}
nameany
Project name filter. Use string for exact match or object with $in/$nin/$like operators. Example: 'My Project' or {'$like': 'Project'}
startobject
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'}
statusany
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']}
metadataany
Project metadata filter. Use string for exact match or object with $in/$nin operators. Example: 'custom-value' or {'$like': 'meta'}
resourcesany
Resource ID filter. Use string for exact match or object with $in/$nin operators. Example: '507f1f77bcf86cd799439011' or {'$in': ['res1', 'res2']}
projectCodeany
Project code filter. Use string for exact match or object with $in/$nin operators. Example: 'PROJ-001' or {'$nin': ['PROJ-999']}
customFieldsValueany
Custom field value filter. Use string for exact match or object with $in/$nin/$like operators. Example: 'High' or {'$like': 'Complete'}
customFieldsTemplateIdany
Custom field template ID filter. Use string for exact match or object with $in/$nin operators. Example: 'template123' or {'$in': ['template1', 'template2']}
customFieldsTemplateLabelany
Custom field template label filter. Use string for exact match or object with $in/$nin/$like operators. Example: 'Priority' or {'$like': 'Status'}

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Resource Custom Field TemplatesHUB_PLANNER_SEARCH_RESOURCE_CUSTOM_FIELD_TEMPLATESAcción

Tool 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.

Parámetros de entrada

typestringenum
Filter templates by custom field type (TEXT, TEXTAREA, EMAIL, DATE, COLOR, NUMBER, CHECKBOX, SELECT, RADIO).
TEXTTEXTAREAEMAILDATECOLORNUMBERCHECKBOXSELECTRADIO
labelstring
Filter templates by label (name of the custom field).
isRequiredboolean
Filter templates by whether the field is required or optional.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search resourcesHUB_PLANNER_SEARCH_RESOURCESAcción

Tool to search for resources with various filters in Hub Planner. Use when you need to find resources by status, name, email, role, or custom fields.

Parámetros de entrada

rolestring
Filter resources by their role in the organization.
emailstring
Filter resources by email address. Typically performs exact match.
statusstring
Filter resources by status. Common values include STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_NON_BOOKABLE, STATUS_PARKED.
lastNamestring
Filter resources by last name. Supports exact match or partial match depending on API implementation.
firstNamestring
Filter resources by first name. Supports exact match or partial match depending on API implementation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Time EntriesHUB_PLANNER_SEARCH_TIME_ENTRIESAcción

Tool 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.

Parámetros de entrada

dateobject
Date filter using comparison operators. Use $lt, $lte, $gt, $gte with date in YYYY-MM-DD format to filter entries by date range
statusany
Status filter. Use string for exact match or object with $in/$nin operators. Valid statuses: UNSUBMITTED, SUBMITTED, APPROVED, REJECTED, PENDING, EMPTY
projectany
Project ID filter. Use string for exact match or object with $in/$nin operators to filter by multiple project IDs
resourceany
Resource ID filter. Use string for exact match or object with $in/$nin operators to filter by multiple resource IDs

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search VacationsHUB_PLANNER_SEARCH_VACATIONSAcción

Tool 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.

Parámetros de entrada

_idobject
Filter operator for vacation search fields supporting MongoDB-style operators.
endobject
Filter operator for vacation search fields supporting MongoDB-style operators.
typeany
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'.
startobject
Filter operator for vacation search fields supporting MongoDB-style operators.
titleany
Filter by vacation title. Can be a single title string or an operator object with $in/$nin arrays.
metadataany
Filter by custom metadata field. Can be a string value or an operator object with $in/$nin arrays.
resourceany
Filter by resource ID. Can be a single ID string or an operator object with $in/$nin arrays.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set Project ManagersHUB_PLANNER_SET_PROJECT_MANAGERSAcción

Tool to set project managers for a Hub Planner project. Replaces existing project managers with the provided list. Requires Project Managers Extension to be enabled.

Parámetros de entrada

project_idstringObligatorio
The unique identifier of the project to set managers for.
project_manager_idsstring[]Obligatorio
Array of resource IDs to set as project managers for this project. Pass an empty array to remove all project managers.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Billing RateHUB_PLANNER_UPDATE_BILLING_RATEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update BookingHUB_PLANNER_UPDATE_BOOKINGAcción

Tool to update an existing booking in Hub Planner by ID. Must pass the entire booking object with all required fields. Use when you need to modify booking properties like dates, resources, projects, state values, or notes.

Parámetros de entrada

_idstringObligatorio
Booking ID (must match booking_id)
endstringObligatorio
End date/time in ISO format (e.g., 2025-12-12T18:00)
notestring
Booking notes or description
typestringObligatorioenum
Booking type (typically SCHEDULED)
SCHEDULED
scalestringObligatorio
Scale type (e.g., SCALE_DAY, SCALE_HOUR)
startstringObligatorio
Start date/time in ISO format (e.g., 2025-12-08T09:00)
statestringObligatorio
State type (e.g., STATE_PERCENTAGE, STATE_CONFIRMED)
titlestring
Booking title
allDaybooleanObligatorio
Whether booking spans all day
repeatboolean
Whether the booking repeats
detailsobject
Booking details with work days and minutes.
projectstringObligatorio
Project ID this booking is associated with
billableboolean
Whether the booking is billable (can be null)
intervalstring
Repeat interval (e.g., NONE, DAILY, WEEKLY)
metadatastring
Additional metadata (max 255 characters)
resourcestringObligatorio
Resource ID assigned to this booking
booking_idstringObligatorio
Booking ID to update
stateValuenumberObligatorio
State value representing percentage (0-100) or hours depending on state type
bookingRateobject
Booking rates for external and internal.
createdDatestring
Creation date in ISO format
updatedDatestring
Last update date in ISO format (can be null)
categoryNamestringObligatorio
Category name
customFieldsobject[]
Array of custom field objects
deadlineNamestring
Deadline name (can be null)
backgroundColorstring
Background color for the booking (hex or color name)
bookingCreatorIdstringObligatorio
ID of the user who created the booking
categoryTemplateIdstringObligatorio
Category template ID

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Booking CategoryHUB_PLANNER_UPDATE_BOOKING_CATEGORYAcción

Tool to update an existing booking category by ID in Hub Planner. Use when you need to modify category properties like name, color, or type.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ClientHUB_PLANNER_UPDATE_CLIENTAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Cost CategoryHUB_PLANNER_UPDATE_COST_CATEGORYAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update EventHUB_PLANNER_UPDATE_EVENTAcción

Tool to update an existing event in Hub Planner by ID. Must pass the entire event object with all required fields. Use when you need to modify event properties like name, status, resources, budget details, colors, or notes.

Parámetros de entrada

_idstring
Event ID (must match event_id). This field is included in the API payload.
namestringObligatorio
Event name. This is the display name for the event and is required.
notestring
Event notes or additional description
linksobject
Event links with icons.
statusstring
Event status (e.g., STATUS_ACTIVE, STATUS_INACTIVE)
event_idstringObligatorio
Event ID to update. Must be a valid Hub Planner event identifier.
metadatastring
Custom metadata field (maximum 255 characters)
eventCodestring
Unique event code identifier. Must be unique across all events.
resourcesstring[]
Array of resource IDs assigned to this event
budgetHoursnumber
Total budget hours for the event
createdDatestring
ISO 8601 timestamp when the event was created (auto-populated by API)
updatedDatestring
ISO 8601 timestamp when the event was last updated (auto-populated by API)
customFieldsobject[]
Array of custom field objects with flexible key-value structure
budgetCurrencystring
Currency code for the budget (e.g., USD, EUR)
backgroundColorstring
Event background color as hex code (e.g., '#349E71')
budgetCashAmountnumber
Total budget cash amount for the event
budgetCategoriesobject[]
Array of budget category objects with hours and amounts

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update HolidayHUB_PLANNER_UPDATE_HOLIDAYAcción

Tool to update an existing holiday by ID in Hub Planner. Must pass the entire holiday object with all required fields (_id, name, date). Use when you need to modify holiday properties such as name, date, color, or recurrence settings.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update MilestoneHUB_PLANNER_UPDATE_MILESTONEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Project Custom Field TemplateHUB_PLANNER_UPDATE_PROJECT_CUSTOM_FIELD_TEMPLATEAcción

Tool 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.

Parámetros de entrada

_idstring
Custom field template ID (must match template_id)
typestringenum
Field type enum for custom field templates.
TEXTTEXTAREANUMBERDATESELECTRADIOCHECKBOX
labelstring
Field label/name displayed to users
statusstringenum
Field status enum for custom field templates.
ACTIVEINACTIVE
choicesobject[]
Array of choice options for SELECT/RADIO/CHECKBOX field types
filterGridboolean
Whether this field can be used to filter in grid views
isRequiredboolean
Whether this field is required when creating/editing projects
template_idstringObligatorio
ID of the custom field template to update
defaultValuestring
Default value for the field
instructionsstring
Instructional text to help users fill in the field
characterLimitstring
Character limit for text-based fields
defaultRadioIdstring
Default radio button ID for RADIO type fields
canResourceEditboolean
Whether resources can edit this field
placeholderTextstring
Placeholder text shown in empty field
allowMultipleValuesboolean
Whether multiple values can be selected (for SELECT/CHECKBOX types)
isChoicesSortedAlphabeticallyboolean
Whether choices should be sorted alphabetically (for SELECT/RADIO/CHECKBOX types)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Project GroupHUB_PLANNER_UPDATE_PROJECT_GROUPAcción

Tool to update an existing project group by ID in Hub Planner. Use when you need to modify a project group's name, associated projects, metadata, or parent group. Returns the updated project group object.

Parámetros de entrada

idstringObligatorio
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.
namestringObligatorio
Group name - the updated name for the project group. This field is required.
metadatastring
Custom metadata field for storing additional information (maximum 255 characters).
projectsstring[]
Array of Project IDs to associate with this group. Pass an empty array to remove all projects from the group.
parentGroupIdstring
Parent group ID for creating subgroup hierarchy. Set to null to make this a top-level group.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Hub Planner projectsHUB_PLANNER_UPDATE_PROJECTSAcción

Tool 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.

Parámetros de entrada

projectsobject[]Obligatorio
Array of project objects to update. Each project must include _id and the properties to update.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Project TagHUB_PLANNER_UPDATE_PROJECT_TAGAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Resource Custom Field TemplateHUB_PLANNER_UPDATE_RESOURCE_CUSTOM_FIELD_TEMPLATEAcción

Tool 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.

Parámetros de entrada

_idstringObligatorio
Custom field template ID (must match template_id)
typestringObligatorioenum
Type of the custom field (TEXT, TEXTAREA, EMAIL, DATE, COLOR, NUMBER, CHECKBOX, SELECT, RADIO)
TEXTTEXTAREAEMAILDATECOLORNUMBERCHECKBOXSELECTRADIO
labelstringObligatorio
Display name/label for the custom field
statusstring
Status of the custom field template (e.g., ACTIVE, INACTIVE)
choicesobject[]
Array of choice options for SELECT/RADIO/CHECKBOX field types
isRequiredboolean
Whether the field is mandatory for resources
template_idstringObligatorio
ID of the custom field template to update (used in URL path)
defaultValuestring
Default value for the field
instructionsstring
Help text or usage instructions for the field
characterLimitstring
Maximum character limit for text-based fields
canResourceEditboolean
Whether resources can edit this field themselves
placeholderTextstring
Placeholder text shown in the input field
allowMultipleValuesboolean
Whether the field allows multiple value selections (for SELECT/CHECKBOX types)
isChoicesSortedAlphabeticallyboolean
Whether choice options should be sorted alphabetically

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Resource GroupHUB_PLANNER_UPDATE_RESOURCE_GROUPAcción

Tool 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.

Parámetros de entrada

idstringObligatorio
Resource group ID to update
namestring
Name of the resource group
metadatastring
Custom metadata field (maximum 255 characters)
approversstring[]
Array of approver IDs to assign to the resource group

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ResourcesHUB_PLANNER_UPDATE_RESOURCESAcción

Tool 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.

Parámetros de entrada

resourcesobject[]Obligatorio
Array of resource objects to update. Each object must include _id and the properties to update. Supports bulk updates by passing multiple resources

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Resource TagHUB_PLANNER_UPDATE_RESOURCE_TAGAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Time EntryHUB_PLANNER_UPDATE_TIME_ENTRYAcción

Tool 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.

Parámetros de entrada

idstringObligatorio
Time entry ID to update. Must be a valid Hub Planner time entry identifier.
datestringObligatorio
Entry date in YYYY-MM-DD format. The date when the time was logged.
notestring
Optional notes or description for this time entry. Use to provide context about the work completed.
statusstringenum
Valid time entry status values.
UNSUBMITTEDSUBMITTEDAPPROVEDREJECTEDPENDINGEMPTY
minutesnumberObligatorio
Duration of the time entry in minutes. For example, 480 minutes = 8 hours, 240 minutes = 4 hours.
projectstringObligatorio
Project ID for this time entry. This identifies the project the time was logged against.
metadatastring
Custom metadata field (max 255 characters). Use for storing additional information.
resourcestringObligatorio
Resource ID associated with this time entry. This identifies the team member who logged the time.
categoryTemplateIdstring
Category template identifier. Used to categorize the type of work logged.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update VacationHUB_PLANNER_UPDATE_VACATIONAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not