# Hub Planner A Modern and Smart Resource Management, Planning & Scheduling tool with Time Sheets and Powerful Reporting. Ideal for Managing Global Teams of Resources. - **Category:** productivity - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 122 - **Triggers:** 0 - **Slug:** `HUB_PLANNER` - **Version:** 20260227_00 ## Tools ### Add Clients to Project **Slug:** `HUB_PLANNER_ADD_CLIENTS_TO_PROJECT` Tool to add clients to a project by project ID. Use when you need to associate one or more clients with a specific project. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_ids` | array | Yes | Array of client IDs to add to the project | | `project_id` | string | Yes | Project ID to add clients to | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add project custom field choices **Slug:** `HUB_PLANNER_ADD_PROJECT_CUSTOM_FIELD_CHOICES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `choices` | array | Yes | List of choice values to add to the custom field template. Each choice must have a 'value' property. | | `template_id` | string | Yes | The unique identifier of the custom field template to add choices to. Must be a SELECT, RADIO, or CHECKBOX type template. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Projects to Group **Slug:** `HUB_PLANNER_ADD_PROJECTS_TO_GROUP` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | 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_ids` | array | Yes | Array of project IDs to add to the project group. Each ID must be a valid project identifier in the Hub Planner system (e.g., ['693ed5dad8729e5dc0c811ed']). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Project Tags **Slug:** `HUB_PLANNER_ADD_PROJECT_TAGS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | Yes | Array of tag IDs to add to the project. These will be appended to existing tags. | | `project_id` | string | Yes | The unique identifier of the project to add tags to. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Resource Custom Field Choices **Slug:** `HUB_PLANNER_ADD_RESOURCE_CUSTOM_FIELD_CHOICES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Custom field template ID to add choices to | | `choices` | array | Yes | Array of choice objects to add to the custom field template. Each choice must have a value property. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Resources to Project **Slug:** `HUB_PLANNER_ADD_RESOURCES_TO_PROJECT` Tool to add resources to a project by project ID. Use when you need to associate one or more resources with a specific project. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_id` | string | Yes | Project ID to add resources to | | `resource_ids` | array | Yes | Array of resource IDs to add to the project | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Resources to Resource Group **Slug:** `HUB_PLANNER_ADD_RESOURCES_TO_RESOURCE_GROUP` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | Resource group ID to add resources to | | `resource_ids` | array | Yes | Array of resource IDs to add to the resource group | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Resource Tags **Slug:** `HUB_PLANNER_ADD_RESOURCE_TAGS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | Yes | Array of tag IDs to add to the resource. New tags will be appended to existing tags without removing any previously assigned tags. | | `resource_id` | string | Yes | The unique identifier of the resource to add tags to. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Billing Rate **Slug:** `HUB_PLANNER_CREATE_BILLING_RATE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rate` | number | Yes | Rate amount in the specified currency. This is the billing rate value that will be charged. | | `label` | string | Yes | Billing rate name. This is the display name for the billing rate and is required for creation. | | `currency` | string | Yes | Currency code for the billing rate (e.g., 'USD', 'EUR', 'GBP'). This determines the currency unit for the rate amount. | | `metadata` | string | No | Custom metadata field for storing additional information (max 255 characters) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Booking **Slug:** `HUB_PLANNER_CREATE_BOOKING` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `end` | string | Yes | Booking end date. Use same format as start date (YYYY-MM-DD or YYYY-MM-DD HH:mm). | | `note` | string | No | Notes or comments about this booking. | | `type` | string ("SCHEDULED" | "WAITING_FOR_APPROVAL" | "APPROVED" | "REJECTED") | No | Valid booking type values. | | `start` | string | Yes | Booking start date. Use YYYY-MM-DD format for day bookings or YYYY-MM-DD HH:mm format for hourly bookings. | | `state` | string ("STATE_DAY_MINUTE" | "STATE_PERCENTAGE" | "STATE_TOTAL_MINUTE") | No | Valid booking state values. | | `title` | string | No | Custom title for the booking. If not provided, defaults to project name. | | `allDay` | boolean | No | Set to false for hourly bookings (requires start/end with HH:mm format). Omit or set to true for all-day bookings. | | `repeat` | boolean | No | Set to true to create a repeating booking. Requires interval to be specified. | | `project` | string | Yes | Project ID to associate with this booking. This identifies the project the resource is being booked on. | | `interval` | string ("WEEKLY" | "MONTHLY" | "YEARLY") | No | Valid repeat interval values. | | `metadata` | string | No | Custom metadata field (max 255 characters) | | `resource` | string | Yes | Resource ID to assign to this booking. This identifies the team member or resource being booked. | | `stateValue` | number | No | 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. | | `bookingRate` | object | No | Billing rate configuration. | | `customFields` | array | No | Array of custom field values for the booking | | `allowOverschedule` | boolean | No | Set to true to allow booking even if resource is already fully scheduled. Overrides overscheduling warnings. | | `repeatEndsAfterTimes` | integer | No | Number of times to repeat the booking. Only used when repeat is true. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Booking Category **Slug:** `HUB_PLANNER_CREATE_BOOKING_CATEGORY` 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"). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Category name. This is the display name for the booking category. | | `type` | string ("NON_OPTIONAL" | "CUSTOM") | Yes | Category type. NON_OPTIONAL indicates the default option within the group. CUSTOM indicates a user-defined category. This field is required. | | `groupId` | string | Yes | Category group ID. This identifies the parent group that will contain this booking category. | | `gridColor` | string | Yes | Category color in hex format (e.g., '#3498db', '#81A489'). This color will be used to display bookings of this category in the calendar/grid views. This field is required. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Client **Slug:** `HUB_PLANNER_CREATE_CLIENT` Tool to create a new client in Hub Planner. Use when you need to add a new client organization to the system. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Client name. This is the display name for the client and is required for creation. | | `metadata` | string | No | Custom metadata field for storing additional client information. Can be used for internal notes or custom data. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Cost Category **Slug:** `HUB_PLANNER_CREATE_COST_CATEGORY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Cost category name. This is the display name for the cost category and is required for creation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Event **Slug:** `HUB_PLANNER_CREATE_EVENT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Event name. This is the display name for the event and is required for creation. | | `metadata` | string | No | Custom metadata field (maximum 255 characters). Can be used to store additional event information. | | `eventCode` | string | No | Unique event code identifier. This is typically used for internal event reference numbers. Must be unique across all events. | | `backgroundColor` | string | No | Event background color as hex code (e.g., '#FF5733'). Used for visual identification in calendars and schedules. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Holiday **Slug:** `HUB_PLANNER_CREATE_HOLIDAY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Holiday date in YYYY-MM-DD format. This is the date when the holiday occurs. | | `name` | string | Yes | Holiday name. This is the display name for the holiday and is required for creation. | | `repeat` | boolean | No | Set to true if the holiday repeats yearly. When true, the holiday will automatically recur every year on the same date. | | `metadata` | string | No | Custom metadata field for the holiday. Use this for any additional custom information you want to store with the holiday. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Milestone **Slug:** `HUB_PLANNER_CREATE_MILESTONE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Milestone date in YYYY-MM-DD format. This is the target date for the milestone. | | `name` | string | Yes | Milestone name. This is the display name for the milestone and is required for creation. | | `project` | string | Yes | Project ID to associate with this milestone. This identifies the project the milestone belongs to. | | `metadata` | string | No | Custom metadata field (maximum 255 characters). Can be used to store additional milestone information. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Project **Slug:** `HUB_PLANNER_CREATE_PROJECT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Project name. This is the display name for the project and is required for creation. | | `note` | string | No | Project notes or description. Free-form text field. | | `status` | string ("STATUS_ACTIVE" | "STATUS_ARCHIVED" | "STATUS_PENDING" | "STATUS_PLANNED" | "STATUS_FLOATING") | No | Valid project status values. | | `resources` | array | No | Array of resource IDs to assign to the project. Resources are team members who will work on the project. | | `budgetHours` | number | No | Total budget hours allocated to the project. Use this for hour-based project budgets. | | `projectCode` | string | No | Unique project code identifier. This is typically used for internal project reference numbers or billing codes. Must be unique across all projects. | | `customFields` | array | No | Custom field values for the project. These are user-defined fields configured in your Hub Planner account. | | `budgetCurrency` | string | No | Currency code for the budget (e.g., 'USD', 'EUR', 'GBP'). Required if budgetCashAmount is specified. | | `projectManagers` | array | No | Array of resource IDs designated as project managers. These users will have manager-level access to the project. | | `budgetCashAmount` | number | No | Cash budget amount for the project. Use in conjunction with budgetCurrency. | | `budgetCategories` | array | No | Budget allocations broken down by category. Use this for detailed budget tracking across different project categories. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Project Custom Field Template **Slug:** `HUB_PLANNER_CREATE_PROJECT_CUSTOM_FIELD_TEMPLATE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("TEXT" | "TEXTAREA" | "EMAIL" | "DATE" | "COLOR" | "NUMBER" | "CHECKBOX" | "SELECT" | "RADIO") | Yes | Field type (TEXT, TEXTAREA, EMAIL, DATE, COLOR, NUMBER, CHECKBOX, SELECT, RADIO) | | `label` | string | Yes | Field label or name | | `status` | string ("ACTIVE" | "INACTIVE") | No | Enum for custom field status. | | `choices` | array | No | Available choices for SELECT, RADIO, or CHECKBOX field types. Required when type is SELECT, RADIO, or CHECKBOX. | | `isRequired` | boolean | No | Whether the field is required. Defaults to false if not specified. | | `defaultValue` | string | No | Default value for the field (for non-choice fields) | | `instructions` | string | No | Instructions or help text for the field | | `characterLimit` | integer | No | Maximum character limit for text fields | | `canResourceEdit` | boolean | No | Whether regular resources can edit this field. Defaults to false if not specified. | | `placeholderText` | string | No | Placeholder text displayed in the input field | | `allowMultipleValues` | boolean | No | Allow multiple selections for SELECT fields. Only applicable when type is SELECT. | | `isChoicesSortedAlphabetically` | boolean | No | Whether choices should be sorted alphabetically. Defaults to true if not specified. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Project Group **Slug:** `HUB_PLANNER_CREATE_PROJECT_GROUP` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Group name. This is the display name for the project group and is required for creation. | | `metadata` | string | No | Custom metadata field (max 255 characters). Use this for storing additional custom information about the project group. | | `parentGroupId` | string | No | Parent group ID for creating a subgroup. Requires Sidebar Pro extension. When specified, this group will be created as a child of the specified parent group. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Project Tag **Slug:** `HUB_PLANNER_CREATE_PROJECT_TAG` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `value` | string | Yes | Project tag value. This is the display name for the tag and is required for creation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Resource **Slug:** `HUB_PLANNER_CREATE_RESOURCE` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `note` | string | No | Notes about the resource | | `role` | string | No | Role assigned to the resource | | `email` | string | No | Resource email address (must be unique). Required if sendInviteEmail is true | | `links` | object | No | Resource links configuration. | | `status` | string ("STATUS_ACTIVE" | "STATUS_ARCHIVED" | "STATUS_NON_BOOKABLE" | "STATUS_PARKED") | No | Resource status values. | | `billing` | object | No | Billing configuration (deprecated). | | `lastName` | string | No | Resource last name | | `metadata` | string | No | Custom metadata field (max 255 characters) | | `firstName` | string | Yes | Resource first name (required) | | `calendarIds` | array | No | Array of calendar IDs associated with the resource | | `customFields` | array | No | Array of custom field values for the resource | | `resourceRates` | object | No | Resource billing rates structure. | | `sendInviteEmail` | boolean | No | Send invitation email to the resource. Requires email field to be set | | `isProjectManager` | boolean | No | Whether the resource is designated as a project manager | | `useCustomAvailability` | boolean | No | Whether to use custom availability settings for the resource | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Resource Custom Field Template **Slug:** `HUB_PLANNER_CREATE_RESOURCE_CUSTOM_FIELD_TEMPLATE` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("TEXT" | "TEXTAREA" | "EMAIL" | "DATE" | "COLOR" | "NUMBER" | "CHECKBOX" | "SELECT" | "RADIO") | Yes | Field type: TEXT, TEXTAREA, EMAIL, DATE, COLOR, NUMBER, CHECKBOX, SELECT, or RADIO | | `label` | string | Yes | Field label that will be displayed to users | | `choices` | array | No | Array of choices for SELECT, RADIO, or CHECKBOX field types. Required for these types, ignored for others | | `isRequired` | boolean | No | Whether the field is mandatory. Defaults to false if not specified | | `instructions` | string | No | Optional instructions or guidance text for field usage | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Resource Tag **Slug:** `HUB_PLANNER_CREATE_RESOURCE_TAG` Tool to create a new resource tag in Hub Planner. Use when you need to add a new tag for categorizing or labeling resources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `value` | string | Yes | The name/value of the resource tag being created. This is required and is the only field allowed in the request body. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Time Entry **Slug:** `HUB_PLANNER_CREATE_TIME_ENTRY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Date of the time entry in YYYY-MM-DD format. | | `note` | string | No | Optional note or description for the time entry. Use this to add context about the work performed. | | `minutes` | integer | Yes | Duration of the time entry in minutes. For example, 480 minutes equals 8 hours. | | `project` | string | Yes | Project ID to associate with this time entry. This identifies the project the time is logged against. | | `metadata` | string | No | Custom metadata field (max 255 characters). | | `resource` | string | Yes | Resource ID to assign the time entry to. This identifies the team member logging the time. | | `categoryTemplateId` | string | No | Category template ID to categorize the time entry. Use this to classify the type of work performed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Vacation **Slug:** `HUB_PLANNER_CREATE_VACATION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `end` | string | Yes | Vacation end date in YYYY-MM-DD format (e.g., '2026-03-20'). Can also use hourly format for precise timing. | | `type` | string ("WAITING_FOR_APPROVAL" | "APPROVED" | "REJECTED") | No | Vacation status/type. Use WAITING_FOR_APPROVAL for new requests pending approval, APPROVED for pre-approved vacation, or REJECTED for denied requests. | | `start` | string | Yes | Vacation start date in YYYY-MM-DD format (e.g., '2026-03-15'). Can also use hourly format for precise timing. | | `title` | string | No | Title or description for the vacation request (e.g., 'Annual Leave', 'Summer Vacation'). | | `metadata` | string | No | Custom metadata field for additional information. | | `resource` | string | Yes | Resource ID for whom the vacation is being created. This is the employee/team member requesting vacation. | | `approvalInfo` | object | No | Approval workflow information. | | `minutesPerDay` | integer | No | Minutes per day for the vacation. Defaults to 480 (8 hours/full day). Adjust for partial day requests. | | `percentAllocation` | number | No | Allocation percentage for the vacation. Defaults to 100 (full day). Use lower values for partial day vacations. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Billing Rate **Slug:** `HUB_PLANNER_DELETE_BILLING_RATE` Tool to delete a specific billing rate by ID in Hub Planner. Use when you need to permanently remove a billing rate. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Billing rate ID to delete. Must be a valid Hub Planner billing rate identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Booking **Slug:** `HUB_PLANNER_DELETE_BOOKING` Tool to delete a specific booking by ID in Hub Planner. Use when you need to permanently remove a booking. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Booking ID to delete. Must be a valid Hub Planner booking identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Bookings **Slug:** `HUB_PLANNER_DELETE_BOOKINGS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | string | No | Comma-separated booking IDs to delete. Example: '693ed5dad8729e5dc0c812fc,693ed5dad8729e5dc0c812fd'. Use this to delete specific bookings by their IDs. | | `projectId` | string | No | Project ID to delete all associated bookings. When provided, all bookings under this project will be deleted. | | `resourceId` | string | No | Resource ID to delete all associated bookings. When provided, all bookings assigned to this resource will be deleted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Client **Slug:** `HUB_PLANNER_DELETE_CLIENT` Tool to delete a specific client by ID in Hub Planner. Use when you need to permanently remove a client organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Client ID to delete. Must be a valid Hub Planner client identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Cost Category **Slug:** `HUB_PLANNER_DELETE_COST_CATEGORY` Tool to delete a specific project cost category by ID in Hub Planner. Use when you need to permanently remove a cost category. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Cost category ID to delete. Must be a valid Hub Planner cost category identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Event **Slug:** `HUB_PLANNER_DELETE_EVENT` Tool to delete a specific event by ID in Hub Planner. Use when you need to permanently remove an event. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Event ID to delete. Must be a valid Hub Planner event identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Holiday **Slug:** `HUB_PLANNER_DELETE_HOLIDAY` Tool to delete a specific holiday by ID in Hub Planner. Use when you need to permanently remove a holiday. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Holiday ID to delete. Must be a valid Hub Planner holiday identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Milestone **Slug:** `HUB_PLANNER_DELETE_MILESTONE` Tool to delete a specific milestone by ID in Hub Planner. Use when you need to permanently remove a milestone. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Milestone ID to delete. Must be a valid Hub Planner milestone identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Project **Slug:** `HUB_PLANNER_DELETE_PROJECT` Tool to delete a specific project by ID in Hub Planner. Use when you need to permanently remove a project. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Project ID to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Project Custom Field Template **Slug:** `HUB_PLANNER_DELETE_PROJECT_CUSTOM_FIELD_TEMPLATE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the project custom field template to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Project Group **Slug:** `HUB_PLANNER_DELETE_PROJECT_GROUP` Tool to delete a specific project group by ID in Hub Planner. Use when you need to permanently remove a project group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Project group ID to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Projects **Slug:** `HUB_PLANNER_DELETE_PROJECTS` Tool to delete multiple projects by their IDs in a single operation. Use when you need to remove multiple projects from Hub Planner. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_ids` | array | Yes | Array of project IDs to delete. Each ID should be a valid project identifier from Hub Planner. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Project Tag **Slug:** `HUB_PLANNER_DELETE_PROJECT_TAG` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the project tag to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Resource **Slug:** `HUB_PLANNER_DELETE_RESOURCE` Tool to delete a specific resource by ID. Use when you need to remove a resource from Hub Planner. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Resource ID to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Resource Custom Field Template **Slug:** `HUB_PLANNER_DELETE_RESOURCE_CUSTOM_FIELD_TEMPLATE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the custom field template to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete resources **Slug:** `HUB_PLANNER_DELETE_RESOURCES` Tool to delete multiple resources by their IDs in a single operation. Use when you need to remove multiple resources from Hub Planner. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `resource_ids` | array | Yes | Array of resource IDs to delete. Each ID should be a valid resource identifier from Hub Planner. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Resource Tag **Slug:** `HUB_PLANNER_DELETE_RESOURCE_TAG` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the resource tag to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Time Entries **Slug:** `HUB_PLANNER_DELETE_TIME_ENTRIES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `time_entry_ids` | array | Yes | Array of time entry IDs to delete. Each ID should be a valid time entry identifier from Hub Planner. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Time Entry **Slug:** `HUB_PLANNER_DELETE_TIME_ENTRY` Tool to delete a specific time entry by ID in Hub Planner. Use when you need to permanently remove a time entry. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Time entry ID to delete. Must be a valid Hub Planner time entry identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Vacation **Slug:** `HUB_PLANNER_DELETE_VACATION` Tool to delete a specific vacation by ID in Hub Planner. Use when you need to permanently remove a vacation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Vacation ID to delete. Must be a valid Hub Planner vacation identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Billing Rate by ID **Slug:** `HUB_PLANNER_GET_BILLING_RATE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Billing rate ID to retrieve. Must be a valid Hub Planner billing rate identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Booking by ID **Slug:** `HUB_PLANNER_GET_BOOKING` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Booking ID to retrieve. Must be a valid Hub Planner booking identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Booking Category by ID **Slug:** `HUB_PLANNER_GET_BOOKING_CATEGORY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Category ID to retrieve. Must be a valid Hub Planner booking category identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Client by ID **Slug:** `HUB_PLANNER_GET_CLIENT` Tool to retrieve a specific client by ID from Hub Planner. Use when you need to fetch detailed information about a client organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Client ID to retrieve. Must be a valid Hub Planner client identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Cost Category **Slug:** `HUB_PLANNER_GET_COST_CATEGORY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Cost category ID - a unique identifier for the project cost category (e.g., '693ed57b314420f795cacde8'). This is required to retrieve the specific cost category details. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Event by ID **Slug:** `HUB_PLANNER_GET_EVENT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Event ID to retrieve. Must be a valid Hub Planner event identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Holiday by ID **Slug:** `HUB_PLANNER_GET_HOLIDAY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Holiday ID to retrieve. Must be a valid Hub Planner holiday identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Milestone **Slug:** `HUB_PLANNER_GET_MILESTONE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Milestone ID - a unique identifier for the milestone (e.g., '698dca3d81fa9038629a2eea'). This is required to retrieve the specific milestone details. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Project **Slug:** `HUB_PLANNER_GET_PROJECT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Project ID - a unique identifier for the project (e.g., '693ed5dad8729e5dc0c811a3'). This is required to retrieve the specific project details. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Project Custom Field Template **Slug:** `HUB_PLANNER_GET_PROJECT_CUSTOM_FIELD_TEMPLATE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Custom field template ID to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Project Custom Field Templates **Slug:** `HUB_PLANNER_GET_PROJECT_CUSTOM_FIELD_TEMPLATES` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Project Group **Slug:** `HUB_PLANNER_GET_PROJECT_GROUP` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Project group ID - a unique identifier for the project group (e.g., '53a168304cc0f1bb16a898ca'). This is required to retrieve the specific project group details. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Project Tags **Slug:** `HUB_PLANNER_GET_PROJECT_TAGS` Tool to retrieve all tags associated with a specific Hub Planner project. Use when you need to view the current tags on a project. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_id` | string | Yes | The unique identifier of the project to retrieve tags for. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Resource by ID **Slug:** `HUB_PLANNER_GET_RESOURCE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Resource ID to retrieve. Must be a valid Hub Planner resource identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Resource Custom Field Template **Slug:** `HUB_PLANNER_GET_RESOURCE_CUSTOM_FIELD_TEMPLATE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Custom field template ID to retrieve. Must be a valid Hub Planner custom field template identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Resource Custom Field Templates **Slug:** `HUB_PLANNER_GET_RESOURCE_CUSTOM_FIELD_TEMPLATES` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Resource Tags **Slug:** `HUB_PLANNER_GET_RESOURCE_TAGS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `resource_id` | string | Yes | The unique identifier of the resource to retrieve tags for. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Time Entry by ID **Slug:** `HUB_PLANNER_GET_TIME_ENTRY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Time entry ID to retrieve. Must be a valid Hub Planner time entry identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Vacation by ID **Slug:** `HUB_PLANNER_GET_VACATION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Vacation ID to retrieve. Must be a valid Hub Planner vacation identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Billing Rates **Slug:** `HUB_PLANNER_LIST_BILLING_RATES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of results. | | `limit` | integer | No | Number of results to return per page. Maximum value is 1000. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Booking Categories **Slug:** `HUB_PLANNER_LIST_BOOKING_CATEGORIES` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Bookings **Slug:** `HUB_PLANNER_LIST_BOOKINGS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of results. | | `limit` | integer | No | Number of results to return per page. Default is 20, maximum is 1000. | | `deleted` | boolean | No | Set to true to include deleted bookings in the results. By default, only active bookings are returned. | | `dependencies` | boolean | No | Set to true to include booking dependencies in the response. Dependencies show relationships between bookings. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Category Groups **Slug:** `HUB_PLANNER_LIST_CATEGORY_GROUPS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Clients **Slug:** `HUB_PLANNER_LIST_CLIENTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number for pagination. Use in conjunction with limit parameter. | | `limit` | integer | No | Maximum number of results to return. Max value is 1000. Default is 0 (unlimited). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Cost Categories **Slug:** `HUB_PLANNER_LIST_COST_CATEGORIES` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Events **Slug:** `HUB_PLANNER_LIST_EVENTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number for pagination, starting at 0 | | `sort` | string | No | Sort field with optional - prefix for descending order (e.g., 'name' for ascending, '-createdDate' for descending) | | `limit` | integer | No | Maximum number of results per page (max 1000) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Holidays **Slug:** `HUB_PLANNER_LIST_HOLIDAYS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Project Groups **Slug:** `HUB_PLANNER_LIST_PROJECT_GROUPS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Project Managers **Slug:** `HUB_PLANNER_LIST_PROJECT_MANAGERS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Projects **Slug:** `HUB_PLANNER_LIST_PROJECTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number for pagination, starting at 0 | | `sort` | string | No | Sort field with optional - prefix for descending order (e.g., 'name' for ascending, '-createdDate' for descending) | | `limit` | integer | No | Maximum number of results per page (max 1000) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Project Tags **Slug:** `HUB_PLANNER_LIST_PROJECT_TAGS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Resource Groups **Slug:** `HUB_PLANNER_LIST_RESOURCE_GROUPS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Resources **Slug:** `HUB_PLANNER_LIST_RESOURCES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number for pagination. Use to navigate through multiple pages of results. | | `sort` | string | No | Field name to sort results by. Examples: 'firstName', 'lastName', 'email', 'createdDate'. | | `limit` | integer | No | Maximum number of results per page. Maximum value is 1000. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Resource Tags **Slug:** `HUB_PLANNER_LIST_RESOURCE_TAGS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Time Entries **Slug:** `HUB_PLANNER_LIST_TIME_ENTRIES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number for pagination. Use to navigate through multiple pages of results. | | `limit` | integer | No | Maximum number of results per page. Default is 20, maximum is 1000. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Unassigned Work **Slug:** `HUB_PLANNER_LIST_UNASSIGNED_WORK` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Vacations **Slug:** `HUB_PLANNER_LIST_VACATIONS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Patch Booking **Slug:** `HUB_PLANNER_PATCH_BOOKING` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Booking ID to patch. Must be a valid Hub Planner booking identifier. | | `end` | string | No | Booking end date and time. Format: YYYY-MM-DDTHH:mm | | `note` | string | No | Notes or comments for this booking | | `type` | string | No | Booking approval type. Use to change the approval state. Possible values: SCHEDULED, APPROVED, WAITING_FOR_APPROVAL, REJECTED | | `start` | string | No | Booking start date and time. Format: YYYY-MM-DDTHH:mm | | `metadata` | string | No | Custom field data or additional metadata (maximum 255 characters) | | `stateValue` | number | No | Numeric value representing the booking state (percentage, minutes, etc. depending on state type) | | `approvalInfo` | object | No | Approval information for booking approval/rejection. | | `allowOverschedule` | boolean | No | Set to true to allow overbooking and override scheduling conflict warnings | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Patch Vacation **Slug:** `HUB_PLANNER_PATCH_VACATION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Vacation ID to update. Must be a valid Hub Planner vacation identifier. | | `end` | string | No | End date-time of the vacation in ISO 8601 format. When the vacation ends. | | `type` | string ("WAITING_FOR_APPROVAL" | "APPROVED" | "REJECTED" | "SCHEDULED") | No | Vacation type/status enumeration. | | `start` | string | No | Start date-time of the vacation in ISO 8601 format. When the vacation begins. | | `state` | string | No | Custom state field for additional vacation status information. | | `title` | string | No | Vacation title or description. A descriptive name for the vacation. | | `project` | string | No | Project ID associated with the vacation, if applicable. | | `metadata` | string | No | Custom metadata field for storing additional information about the vacation. | | `resource` | string | No | Resource ID (employee/team member) associated with the vacation. | | `approvalInfo` | object | No | Approval information for vacation requests. | | `minutesPerDay` | integer | No | Number of vacation minutes per day. Used for partial day vacations. | | `percentAllocation` | integer | No | Percentage allocation for the vacation (0-100). Useful for partial day absences. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Client From Projects **Slug:** `HUB_PLANNER_REMOVE_CLIENT_FROM_PROJECTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_id` | string | Yes | The unique identifier of the client to remove from projects | | `project_ids` | array | Yes | Array of project IDs from which to remove the client. Must contain at least one project ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Project From Groups **Slug:** `HUB_PLANNER_REMOVE_PROJECT_FROM_GROUPS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_ids` | array | Yes | Array of project group IDs from which to remove the project. Must contain at least one group ID. | | `project_id` | string | Yes | The unique identifier of the project to remove from groups | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Project Tag **Slug:** `HUB_PLANNER_REMOVE_PROJECT_TAG` Tool to remove a tag from a Hub Planner project. Use when you need to detach a tag from a specific project. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag_id` | string | Yes | The unique identifier of the tag to remove from the project | | `project_id` | string | Yes | The unique identifier of the project | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Resource from Projects **Slug:** `HUB_PLANNER_REMOVE_RESOURCE_FROM_PROJECTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_ids` | array | Yes | Array of project IDs from which to remove the resource | | `resource_id` | string | Yes | The ID of the resource to remove from projects | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Resource Tag **Slug:** `HUB_PLANNER_REMOVE_RESOURCE_TAG` Tool to remove a tag from a resource. Use when you need to disassociate a specific tag from a resource. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag_id` | string | Yes | The unique identifier of the tag to remove from the resource. | | `resource_id` | string | Yes | The unique identifier of the resource from which to remove the tag. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Billing Rates **Slug:** `HUB_PLANNER_SEARCH_BILLING_RATES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rate` | number | No | Filter by billing rate amount. Exact match filter for the numeric rate value. | | `label` | string | No | Filter by billing rate label/name. Exact match filter. | | `currency` | string | No | Filter by currency code (e.g., USD, EUR, GBP). Exact match filter. | | `metadata` | string | No | Filter by custom metadata field (max 255 characters). Exact match filter. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Booking Categories **Slug:** `HUB_PLANNER_SEARCH_BOOKING_CATEGORIES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Filter by category name. Supports partial string matching (includes). Use to find categories with names containing this string. | | `type` | string | No | Filter by category type. Valid values: NON_OPTIONAL (default type) or CUSTOM. Use to find categories of a specific type. | | `group` | string | No | Filter by category group ID. Use to find all categories belonging to a specific category group. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Bookings **Slug:** `HUB_PLANNER_SEARCH_BOOKINGS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | object | No | Filter operator for booking search fields supporting MongoDB-style operators. | | `end` | string | No | Filter by end date. Can be a date string (YYYY-MM-DD) or an operator object with date comparison operators ($lt, $lte, $gte, $gt). | | `start` | string | No | Filter by start date. Can be a date string (YYYY-MM-DD) or an operator object with date comparison operators ($lt, $lte, $gte, $gt). | | `deleted` | boolean | No | Set to true to retrieve only deleted bookings. Set to false or omit to retrieve active bookings. | | `project` | string | No | Filter by project ID. Can be a single ID string or an operator object with $in/$nin arrays. | | `metadata` | string | No | Filter by custom metadata field (max 255 characters). Can be a string value or an operator object. | | `resource` | string | No | Filter by resource ID. Can be a single ID string or an operator object with $in/$nin arrays. | | `deletedDate` | object | No | Filter operator for booking search fields supporting MongoDB-style operators. | | `updatedDate` | object | No | Filter operator for booking search fields supporting MongoDB-style operators. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Clients **Slug:** `HUB_PLANNER_SEARCH_CLIENTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Client name filter. Use string for exact match or object with $in/$nin/$like operators. Example: 'Acme Corp' or {'$like': 'Acme'} | | `metadata` | string | No | Client metadata filter. Use string for exact match or object with $in/$nin/$like operators. Example: 'custom-value' or {'$like': 'meta'} | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Cost Categories **Slug:** `HUB_PLANNER_SEARCH_COST_CATEGORIES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | string | No | Cost category ID filter. Use string for exact match or object with $in/$nin for multiple values. Example: '5f057949f338cd432a794a12' or {'$in': ['id1', 'id2']} | | `name` | string | No | Cost category name filter. Use string for exact match or object with $in/$nin operators. Example: 'Office' or {'$in': ['Office', 'Travel']} | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Events **Slug:** `HUB_PLANNER_SEARCH_EVENTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | string | No | Event ID filter. Use string for exact match or object with $in/$nin for multiple values | | `name` | string | No | Event name filter. Use string for exact match or object with $in/$nin operators | | `metadata` | string | No | Metadata filter. Use string for exact match or object with $in/$nin operators | | `eventCode` | string | No | Event code filter. Use string for exact match or object with $in/$nin operators | | `resources` | string | No | Resource ID filter. Use string for exact match or object with $in/$nin operators to filter events by associated resources | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Holidays **Slug:** `HUB_PLANNER_SEARCH_HOLIDAYS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | string | No | Holiday ID filter. Use string for exact match or object with $in/$nin for multiple values | | `date` | object | No | Holiday date filter using comparison operators. Use $lt, $lte, or $gte with date in YYYY-MM-DD format | | `name` | string | No | Holiday name filter. Use string for exact match or object with $in/$nin operators | | `metadata` | string | No | Holiday metadata filter. Use string for exact match or object with $in/$nin operators | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Milestones **Slug:** `HUB_PLANNER_SEARCH_MILESTONES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | object | No | Filter operator for milestone search fields supporting MongoDB-style operators. | | `date` | string | No | Filter by milestone date. Can be a date string (YYYY-MM-DD) or an operator object with date comparison operators ($lt, $lte, $gte). | | `name` | string | No | Filter by milestone name. Can be a string for exact match or an operator object with $in/$nin arrays. | | `project` | string | No | Filter by project ID. Can be a single ID string or an operator object with $in/$nin arrays. | | `metadata` | string | No | Filter by custom metadata field. Can be a string value or an operator object with $in/$nin arrays. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Project Custom Fields **Slug:** `HUB_PLANNER_SEARCH_PROJECT_CUSTOM_FIELDS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("TEXT" | "TEXTAREA" | "EMAIL" | "DATE" | "COLOR" | "NUMBER" | "CHECKBOX" | "SELECT" | "RADIO") | No | Enum for custom field types in Hub Planner. | | `label` | string | No | Filter by custom field label. Supports search operators like $in, $nin, $like for advanced filtering. | | `isRequired` | boolean | No | Filter by whether the field is required. Set to true for required fields, false for optional fields, or omit to return all. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Projects **Slug:** `HUB_PLANNER_SEARCH_PROJECTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | string | No | Project ID filter. Use string for exact match or object with $in/$nin for multiple values. Example: '507f1f77bcf86cd799439011' or {'$in': ['id1', 'id2']} | | `end` | object | No | 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'} | | `name` | string | No | Project name filter. Use string for exact match or object with $in/$nin/$like operators. Example: 'My Project' or {'$like': 'Project'} | | `start` | object | No | 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'} | | `status` | string | No | 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']} | | `metadata` | string | No | Project metadata filter. Use string for exact match or object with $in/$nin operators. Example: 'custom-value' or {'$like': 'meta'} | | `resources` | string | No | Resource ID filter. Use string for exact match or object with $in/$nin operators. Example: '507f1f77bcf86cd799439011' or {'$in': ['res1', 'res2']} | | `projectCode` | string | No | Project code filter. Use string for exact match or object with $in/$nin operators. Example: 'PROJ-001' or {'$nin': ['PROJ-999']} | | `customFieldsValue` | string | No | Custom field value filter. Use string for exact match or object with $in/$nin/$like operators. Example: 'High' or {'$like': 'Complete'} | | `customFieldsTemplateId` | string | No | Custom field template ID filter. Use string for exact match or object with $in/$nin operators. Example: 'template123' or {'$in': ['template1', 'template2']} | | `customFieldsTemplateLabel` | string | No | Custom field template label filter. Use string for exact match or object with $in/$nin/$like operators. Example: 'Priority' or {'$like': 'Status'} | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Resource Custom Field Templates **Slug:** `HUB_PLANNER_SEARCH_RESOURCE_CUSTOM_FIELD_TEMPLATES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("TEXT" | "TEXTAREA" | "EMAIL" | "DATE" | "COLOR" | "NUMBER" | "CHECKBOX" | "SELECT" | "RADIO") | No | Filter templates by custom field type (TEXT, TEXTAREA, EMAIL, DATE, COLOR, NUMBER, CHECKBOX, SELECT, RADIO). | | `label` | string | No | Filter templates by label (name of the custom field). | | `isRequired` | boolean | No | Filter templates by whether the field is required or optional. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search resources **Slug:** `HUB_PLANNER_SEARCH_RESOURCES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `role` | string | No | Filter resources by their role in the organization. | | `email` | string | No | Filter resources by email address. Typically performs exact match. | | `status` | string | No | Filter resources by status. Common values include STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_NON_BOOKABLE, STATUS_PARKED. | | `lastName` | string | No | Filter resources by last name. Supports exact match or partial match depending on API implementation. | | `firstName` | string | No | Filter resources by first name. Supports exact match or partial match depending on API implementation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Time Entries **Slug:** `HUB_PLANNER_SEARCH_TIME_ENTRIES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | object | No | Date filter using comparison operators. Use $lt, $lte, $gt, $gte with date in YYYY-MM-DD format to filter entries by date range | | `status` | string | No | Status filter. Use string for exact match or object with $in/$nin operators. Valid statuses: UNSUBMITTED, SUBMITTED, APPROVED, REJECTED, PENDING, EMPTY | | `project` | string | No | Project ID filter. Use string for exact match or object with $in/$nin operators to filter by multiple project IDs | | `resource` | string | No | Resource ID filter. Use string for exact match or object with $in/$nin operators to filter by multiple resource IDs | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Vacations **Slug:** `HUB_PLANNER_SEARCH_VACATIONS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | object | No | Filter operator for vacation search fields supporting MongoDB-style operators. | | `end` | object | No | Filter operator for vacation search fields supporting MongoDB-style operators. | | `type` | string | No | 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'. | | `start` | object | No | Filter operator for vacation search fields supporting MongoDB-style operators. | | `title` | string | No | Filter by vacation title. Can be a single title string or an operator object with $in/$nin arrays. | | `metadata` | string | No | Filter by custom metadata field. Can be a string value or an operator object with $in/$nin arrays. | | `resource` | string | No | Filter by resource ID. Can be a single ID string or an operator object with $in/$nin arrays. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Project Managers **Slug:** `HUB_PLANNER_SET_PROJECT_MANAGERS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_id` | string | Yes | The unique identifier of the project to set managers for. | | `project_manager_ids` | array | Yes | Array of resource IDs to set as project managers for this project. Pass an empty array to remove all project managers. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Billing Rate **Slug:** `HUB_PLANNER_UPDATE_BILLING_RATE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | string | Yes | Billing rate ID (must match billing_rate_id parameter). Required in the request body for update. | | `rate` | number | Yes | Billing rate amount. The numeric value representing the billing rate. | | `label` | string | Yes | The name of billing rate. A descriptive label for this rate. | | `currency` | string | Yes | Currency code (e.g., USD, EUR, GBP). Must be a valid 3-letter ISO currency code. | | `metadata` | string | No | Custom metadata field (max 255 characters). Use for storing additional information about the billing rate. | | `createdDate` | string | No | Creation timestamp in ISO 8601 format. Typically set by the system on creation. | | `updatedDate` | string | No | Last update timestamp in ISO 8601 format. Updated automatically by the system. | | `billing_rate_id` | string | Yes | Billing rate ID to update. Must be a valid Hub Planner billing rate identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Booking **Slug:** `HUB_PLANNER_UPDATE_BOOKING` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | string | Yes | Booking ID (must match booking_id) | | `end` | string | Yes | End date/time in ISO format (e.g., 2025-12-12T18:00) | | `note` | string | No | Booking notes or description | | `type` | string ("SCHEDULED") | Yes | Booking type (typically SCHEDULED) | | `scale` | string | Yes | Scale type (e.g., SCALE_DAY, SCALE_HOUR) | | `start` | string | Yes | Start date/time in ISO format (e.g., 2025-12-08T09:00) | | `state` | string | Yes | State type (e.g., STATE_PERCENTAGE, STATE_CONFIRMED) | | `title` | string | No | Booking title | | `allDay` | boolean | Yes | Whether booking spans all day | | `repeat` | boolean | No | Whether the booking repeats | | `details` | object | No | Booking details with work days and minutes. | | `project` | string | Yes | Project ID this booking is associated with | | `billable` | boolean | No | Whether the booking is billable (can be null) | | `interval` | string | No | Repeat interval (e.g., NONE, DAILY, WEEKLY) | | `metadata` | string | No | Additional metadata (max 255 characters) | | `resource` | string | Yes | Resource ID assigned to this booking | | `booking_id` | string | Yes | Booking ID to update | | `stateValue` | number | Yes | State value representing percentage (0-100) or hours depending on state type | | `bookingRate` | object | No | Booking rates for external and internal. | | `createdDate` | string | No | Creation date in ISO format | | `updatedDate` | string | No | Last update date in ISO format (can be null) | | `categoryName` | string | Yes | Category name | | `customFields` | array | No | Array of custom field objects | | `deadlineName` | string | No | Deadline name (can be null) | | `backgroundColor` | string | No | Background color for the booking (hex or color name) | | `bookingCreatorId` | string | Yes | ID of the user who created the booking | | `categoryTemplateId` | string | Yes | Category template ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Booking Category **Slug:** `HUB_PLANNER_UPDATE_BOOKING_CATEGORY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Category ID to update | | `name` | string | No | Category name - the updated name for the booking category | | `type` | string ("CUSTOM" | "NON_OPTIONAL") | Yes | Category type - either CUSTOM or NON_OPTIONAL. This field is required. | | `gridColor` | string | No | Category color in hex format (e.g., #DB6060) for calendar/grid display | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Client **Slug:** `HUB_PLANNER_UPDATE_CLIENT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Client ID to update. Must be a valid Hub Planner client identifier. | | `name` | string | Yes | Updated name for the client. This is the only property that can be updated for a client. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Cost Category **Slug:** `HUB_PLANNER_UPDATE_COST_CATEGORY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Cost category ID to update. Must be a valid Hub Planner cost category identifier. | | `name` | string | Yes | Updated name for the cost category. This is the primary property for categorizing project costs. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Event **Slug:** `HUB_PLANNER_UPDATE_EVENT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | string | No | Event ID (must match event_id). This field is included in the API payload. | | `name` | string | Yes | Event name. This is the display name for the event and is required. | | `note` | string | No | Event notes or additional description | | `links` | object | No | Event links with icons. | | `status` | string | No | Event status (e.g., STATUS_ACTIVE, STATUS_INACTIVE) | | `event_id` | string | Yes | Event ID to update. Must be a valid Hub Planner event identifier. | | `metadata` | string | No | Custom metadata field (maximum 255 characters) | | `eventCode` | string | No | Unique event code identifier. Must be unique across all events. | | `resources` | array | No | Array of resource IDs assigned to this event | | `budgetHours` | number | No | Total budget hours for the event | | `createdDate` | string | No | ISO 8601 timestamp when the event was created (auto-populated by API) | | `updatedDate` | string | No | ISO 8601 timestamp when the event was last updated (auto-populated by API) | | `customFields` | array | No | Array of custom field objects with flexible key-value structure | | `budgetCurrency` | string | No | Currency code for the budget (e.g., USD, EUR) | | `backgroundColor` | string | No | Event background color as hex code (e.g., '#349E71') | | `budgetCashAmount` | number | No | Total budget cash amount for the event | | `budgetCategories` | array | No | Array of budget category objects with hours and amounts | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Holiday **Slug:** `HUB_PLANNER_UPDATE_HOLIDAY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | string | Yes | Holiday ID (must match holiday_id parameter). Required in the request body for update. | | `date` | string | Yes | Holiday date in YYYY-MM-DD format. The date when the holiday occurs. | | `name` | string | Yes | Holiday name. A descriptive name for the holiday. | | `color` | string | No | Hex color code for the holiday display (e.g., #0070c0, #ff0000). Used in calendar views. | | `repeat` | boolean | No | Whether the holiday repeats annually. Set to true for recurring holidays like Christmas or New Year. | | `metadata` | string | No | Custom metadata field (max 255 characters). Use for storing additional information about the holiday. | | `holiday_id` | string | Yes | Holiday ID to update. Must be a valid Hub Planner holiday identifier. | | `createdDate` | string | No | Creation timestamp in ISO 8601 format. Typically set by the system on creation. | | `updatedDate` | string | No | Last update timestamp in ISO 8601 format. Updated automatically by the system. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Milestone **Slug:** `HUB_PLANNER_UPDATE_MILESTONE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | string | Yes | Milestone ID (must match milestone_id parameter). Required in the request body for update. | | `date` | string | Yes | Milestone date in YYYY-MM-DD format. The date when the milestone is due. | | `name` | string | Yes | Milestone name. A descriptive name for the milestone. | | `project` | string | Yes | Project ID reference. The project this milestone belongs to. | | `metadata` | string | No | Custom metadata field (max 255 characters). Use for storing additional information about the milestone. | | `milestone_id` | string | Yes | Milestone ID to update. Must be a valid Hub Planner milestone identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Project Custom Field Template **Slug:** `HUB_PLANNER_UPDATE_PROJECT_CUSTOM_FIELD_TEMPLATE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | string | No | Custom field template ID (must match template_id) | | `type` | string ("TEXT" | "TEXTAREA" | "NUMBER" | "DATE" | "SELECT" | "RADIO" | "CHECKBOX") | No | Field type enum for custom field templates. | | `label` | string | No | Field label/name displayed to users | | `status` | string ("ACTIVE" | "INACTIVE") | No | Field status enum for custom field templates. | | `choices` | array | No | Array of choice options for SELECT/RADIO/CHECKBOX field types | | `filterGrid` | boolean | No | Whether this field can be used to filter in grid views | | `isRequired` | boolean | No | Whether this field is required when creating/editing projects | | `template_id` | string | Yes | ID of the custom field template to update | | `defaultValue` | string | No | Default value for the field | | `instructions` | string | No | Instructional text to help users fill in the field | | `characterLimit` | string | No | Character limit for text-based fields | | `defaultRadioId` | string | No | Default radio button ID for RADIO type fields | | `canResourceEdit` | boolean | No | Whether resources can edit this field | | `placeholderText` | string | No | Placeholder text shown in empty field | | `allowMultipleValues` | boolean | No | Whether multiple values can be selected (for SELECT/CHECKBOX types) | | `isChoicesSortedAlphabetically` | boolean | No | Whether choices should be sorted alphabetically (for SELECT/RADIO/CHECKBOX types) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Project Group **Slug:** `HUB_PLANNER_UPDATE_PROJECT_GROUP` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | 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. | | `name` | string | Yes | Group name - the updated name for the project group. This field is required. | | `metadata` | string | No | Custom metadata field for storing additional information (maximum 255 characters). | | `projects` | array | No | Array of Project IDs to associate with this group. Pass an empty array to remove all projects from the group. | | `parentGroupId` | string | No | Parent group ID for creating subgroup hierarchy. Set to null to make this a top-level group. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Hub Planner projects **Slug:** `HUB_PLANNER_UPDATE_PROJECTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `projects` | array | Yes | Array of project objects to update. Each project must include _id and the properties to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Project Tag **Slug:** `HUB_PLANNER_UPDATE_PROJECT_TAG` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Project tag ID to update. Must be a valid Hub Planner project tag identifier. | | `value` | string | Yes | New tag value. The updated name/value for this project tag. Cannot be a value that already exists for another tag. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Resource Custom Field Template **Slug:** `HUB_PLANNER_UPDATE_RESOURCE_CUSTOM_FIELD_TEMPLATE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `_id` | string | Yes | Custom field template ID (must match template_id) | | `type` | string ("TEXT" | "TEXTAREA" | "EMAIL" | "DATE" | "COLOR" | "NUMBER" | "CHECKBOX" | "SELECT" | "RADIO") | Yes | Type of the custom field (TEXT, TEXTAREA, EMAIL, DATE, COLOR, NUMBER, CHECKBOX, SELECT, RADIO) | | `label` | string | Yes | Display name/label for the custom field | | `status` | string | No | Status of the custom field template (e.g., ACTIVE, INACTIVE) | | `choices` | array | No | Array of choice options for SELECT/RADIO/CHECKBOX field types | | `isRequired` | boolean | No | Whether the field is mandatory for resources | | `template_id` | string | Yes | ID of the custom field template to update (used in URL path) | | `defaultValue` | string | No | Default value for the field | | `instructions` | string | No | Help text or usage instructions for the field | | `characterLimit` | integer | No | Maximum character limit for text-based fields | | `canResourceEdit` | boolean | No | Whether resources can edit this field themselves | | `placeholderText` | string | No | Placeholder text shown in the input field | | `allowMultipleValues` | boolean | No | Whether the field allows multiple value selections (for SELECT/CHECKBOX types) | | `isChoicesSortedAlphabetically` | boolean | No | Whether choice options should be sorted alphabetically | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Resource Group **Slug:** `HUB_PLANNER_UPDATE_RESOURCE_GROUP` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Resource group ID to update | | `name` | string | No | Name of the resource group | | `metadata` | string | No | Custom metadata field (maximum 255 characters) | | `approvers` | array | No | Array of approver IDs to assign to the resource group | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Resources **Slug:** `HUB_PLANNER_UPDATE_RESOURCES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `resources` | array | Yes | Array of resource objects to update. Each object must include _id and the properties to update. Supports bulk updates by passing multiple resources | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Resource Tag **Slug:** `HUB_PLANNER_UPDATE_RESOURCE_TAG` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Resource tag ID to update. Must be a valid Hub Planner resource tag identifier. | | `value` | string | Yes | New tag value. The updated name/value for this resource tag. Cannot be a value that already exists for another tag. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Time Entry **Slug:** `HUB_PLANNER_UPDATE_TIME_ENTRY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Time entry ID to update. Must be a valid Hub Planner time entry identifier. | | `date` | string | Yes | Entry date in YYYY-MM-DD format. The date when the time was logged. | | `note` | string | No | Optional notes or description for this time entry. Use to provide context about the work completed. | | `status` | string ("UNSUBMITTED" | "SUBMITTED" | "APPROVED" | "REJECTED" | "PENDING" | "EMPTY") | No | Valid time entry status values. | | `minutes` | number | Yes | Duration of the time entry in minutes. For example, 480 minutes = 8 hours, 240 minutes = 4 hours. | | `project` | string | Yes | Project ID for this time entry. This identifies the project the time was logged against. | | `metadata` | string | No | Custom metadata field (max 255 characters). Use for storing additional information. | | `resource` | string | Yes | Resource ID associated with this time entry. This identifies the team member who logged the time. | | `categoryTemplateId` | string | No | Category template identifier. Used to categorize the type of work logged. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Vacation **Slug:** `HUB_PLANNER_UPDATE_VACATION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `end` | string | No | Vacation end date/time in ISO 8601 format (e.g., 2018-07-26T18:00:00.000Z) | | `type` | string ("WAITING_FOR_APPROVAL" | "APPROVED" | "REJECTED") | No | Vacation type enumeration for approval status. | | `start` | string | No | Vacation start date/time in ISO 8601 format (e.g., 2018-07-25T09:00:00.000Z) | | `title` | string | No | Title or description of the vacation request | | `metadata` | string | No | Custom metadata field (max 255 characters). Use for storing additional information about the vacation. | | `vacation_id` | string | Yes | Vacation ID to update. Must be a valid Hub Planner vacation identifier. | | `approvalInfo` | object | No | Approval information required when type is APPROVED or REJECTED. | | `minutesPerDay` | integer | No | Minutes per day for the vacation. Defaults to 480 (8 hours) if not specified. | | `percentAllocation` | integer | No | Percentage allocation for the vacation (0-100). Defaults to 100 if not specified. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |