# Hubstaff

> Read Hubstaff organizations, tracked work and teams and create projects and tasks.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/hubstaff

## Actions

### Create project

Create project.

**Inputs**

- Organization (`organization_id`, number, required): Organization id.
- Name (`name`, text, required): Project name
- Description (`description`, text): Project description
- Metadata (`metadata`, list): Project metadata. See the update_metadata endpoint
- Members (`members`, list): Members.
- Client Id (`client_id`, number): The client ID
- Billable (`billable`, true/false): Whether activity logged against this project is billable by default (default is true)
- Budget Type (`budget_type`, text): The method for controlling the budget. One of: `cost`, `hours`.
- Budget Rate (`budget_rate`, text): When budget type is cost, specifies which rate to use. One of: `bill_rate` (Bill rate), `pay_rate` (Pay rate). Default: `bill_rate`.
- Budget Cost (`budget_cost`, number): When budget type is cost. defines the cost limit.
- Budget Hours (`budget_hours`, number): When budget type is hours. defines the hours limit.
- Budget Start Date (`budget_start_date`, date): The start date for the budget.
- Budget Recurrence (`budget_recurrence`, text): If given, makes budget reset on a weekly or monthly basis. One of: `weekly`, `monthly`.
- Budget Recurrence Start (`budget_recurrence_start`, number): Day of week (0-6, 0=Sunday) for weekly recurrence, or day of month (1-31) for monthly recurrence
- Budget Include Non Billable (`budget_include_non_billable`, true/false): Whether the budget includes non billable time. Default: `true`.
- Budget Stop Timer When Budget Reached (`budget_stop_timer_when_budget_reached`, true/false): Whether to stop timers when budget limit is reached
- Budget Stop At (`budget_stop_at`, number): The budget percentage at which timers stop automatically
- Budget Alerts Near Limit (`budget_alerts_near_limit`, number): The percentage threshold for notifying when approaching the budget.
- Budget Alerts Notify Enabled (`budget_alerts_notify_enabled`, true/false): Whether budget notifications are enabled
- Budget Alerts Notify All Members (`budget_alerts_notify_all_members`, true/false): Whether to notify all project members
- Budget Alerts Notify Group (`budget_alerts_notify_group`, text): The group to notify. One of: `all_members` (All members), `org_management` (Org management).
- Pay Rate (`pay_rate`, number): Default pay rate (will be rounded to 2 decimal places). Set to null to remove the rate
- Bill Rate (`bill_rate`, number): Default bill rate (will be rounded to 2 decimal places). Set to null to remove the rate

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "project": {
      "bill_rate": 1.0,
      "billable": false,
      "budget": {
        "alerts": {
          "near_limit": 1,
          "notify_all_members": false,
          "notify_enabled": false,
          "notify_group": "example"
        },
        "cost": 1.0,
        "hours": 1.0,
        "include_non_billable": false,
        "rate": "example",
        "recurrence": "example",
        "recurrence_start": 1,
        "start_date": "example",
        "stop_at": 1,
        "stop_timer_when_budget_reached": false,
        "type": "example"
      },
      "client_id": 1,
      "created_at": "example",
      "description": "example",
      "id": 1,
      "metadata": {},
      "name": "example",
      "pay_rate": 1.0,
      "status": "example",
      "type": "example",
      "updated_at": "example"
    }
  }
}
```

### Create task

Create task.

**Inputs**

- Project Id (`project_id`, number, required): Project id.
- Assignee Id (`assignee_id`, number): Assignee Id
- Assignee Ids (`assignee_ids`, list): Assignee Ids
- Summary (`summary`, text, required): To-do summary
- Pay Rate (`pay_rate`, number): Pay rate. Set to null to remove
- Bill Rate (`bill_rate`, number): Bill rate. Set to null to remove
- Metadata (`metadata`, list): Task metadata. See the update_metadata endpoint

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "task": {
      "assignee_ids": [],
      "bill_rate": 1.0,
      "completed_at": "example",
      "created_at": "example",
      "details": "example",
      "due_at": "example",
      "global_todo_id": 1,
      "id": 1,
      "integration_id": 1,
      "lock_version": 1,
      "metadata": {},
      "pay_rate": 1.0,
      "project_id": 1,
      "project_type": "example",
      "remote_alternate_id": "example",
      "remote_id": "example",
      "status": "example",
      "summary": "example",
      "updated_at": "example"
    }
  }
}
```

### Delete task

Delete task.

**Inputs**

- Task Id (`task_id`, number, required): Task ID

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "task": {
      "assignee_ids": [],
      "bill_rate": 1.0,
      "completed_at": "example",
      "created_at": "example",
      "details": "example",
      "due_at": "example",
      "global_todo_id": 1,
      "id": 1,
      "integration_id": 1,
      "lock_version": 1,
      "metadata": {},
      "pay_rate": 1.0,
      "project_id": 1,
      "project_type": "example",
      "remote_alternate_id": "example",
      "remote_id": "example",
      "status": "example",
      "summary": "example",
      "updated_at": "example"
    }
  }
}
```

### Get client

Get client.

**Inputs**

- Client Id (`client_id`, number, required): Client ID

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "client": {
      "address": "example",
      "budget": {
        "alerts": {
          "near_limit": 1,
          "notify_all_members": false,
          "notify_enabled": false,
          "notify_group": "example"
        },
        "cost": 1.0,
        "hours": 1.0,
        "include_non_billable": false,
        "rate": "example",
        "recurrence": "example",
        "recurrence_start": 1,
        "start_date": "example",
        "stop_at": 1,
        "stop_timer_when_budget_reached": false,
        "type": "example"
      },
      "created_at": "example",
      "emails": [],
      "id": 1,
      "inherit_invoice_notes": false,
      "inherit_net_terms": false,
      "invoice_notes": "example",
      "metadata": {},
      "name": "example",
      "net_terms": "example",
      "organization_id": 1,
      "phone": "example",
      "project_ids": [],
      "status": "example",
      "updated_at": "example"
    }
  }
}
```

### Get current user

Get current user.

**Inputs**: None.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "user": {
      "created_at": "example",
      "email": "example",
      "first_name": "example",
      "id": 1,
      "ip_address": "example",
      "last_name": "example",
      "name": "example",
      "status": "example",
      "time_zone": "example",
      "updated_at": "example"
    }
  }
}
```

### Get organization

Get organization.

**Inputs**

- Organization (`organization_id`, number, required): Organization ID

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "organization": {
      "created_at": "example",
      "id": 1,
      "invite_url": "example",
      "member_profile_fields": [],
      "metadata": {},
      "name": "example",
      "status": "example",
      "updated_at": "example"
    }
  }
}
```

### Get project

Get project.

**Inputs**

- Project Id (`project_id`, number, required): Project ID

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "project": {
      "bill_rate": 1.0,
      "billable": false,
      "budget": {
        "alerts": {
          "near_limit": 1,
          "notify_all_members": false,
          "notify_enabled": false,
          "notify_group": "example"
        },
        "cost": 1.0,
        "hours": 1.0,
        "include_non_billable": false,
        "rate": "example",
        "recurrence": "example",
        "recurrence_start": 1,
        "start_date": "example",
        "stop_at": 1,
        "stop_timer_when_budget_reached": false,
        "type": "example"
      },
      "client_id": 1,
      "created_at": "example",
      "description": "example",
      "id": 1,
      "metadata": {},
      "name": "example",
      "pay_rate": 1.0,
      "status": "example",
      "type": "example",
      "updated_at": "example"
    }
  }
}
```

### Get task

Get task.

**Inputs**

- Task Id (`task_id`, number, required): Task ID

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "task": {
      "assignee_ids": [],
      "bill_rate": 1.0,
      "completed_at": "example",
      "created_at": "example",
      "details": "example",
      "due_at": "example",
      "global_todo_id": 1,
      "id": 1,
      "integration_id": 1,
      "lock_version": 1,
      "metadata": {},
      "pay_rate": 1.0,
      "project_id": 1,
      "project_type": "example",
      "remote_alternate_id": "example",
      "remote_id": "example",
      "status": "example",
      "summary": "example",
      "updated_at": "example"
    }
  }
}
```

### Get team

Get team.

**Inputs**

- Vendor Team Id (`vendor_team_id`, number, required): Team ID

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "team": {
      "created_at": "example",
      "id": 1,
      "lead_options": {
        "approve_manual_time": false,
        "approve_time_off": false,
        "approve_timesheets": false,
        "invite_members_to_organization": false,
        "manage_billing": false,
        "manage_team_members": false,
        "manage_team_projects": false,
        "notifications_for_job_sites": false,
        "notifications_for_job_sites_only_leads": false,
        "notifications_for_limits": false,
        "notifications_for_limits_only_leads": false,
        "notifications_for_schedules_only_leads": false,
        "notifications_for_time_off_only_leads": false,
        "notifications_for_timesheets_only_leads": false,
        "notifications_work_breaks": false,
        "notifications_work_breaks_only_leads": false,
        "others_screenshots": false,
        "receive_manual_time_notification": false,
        "schedule_shifts": false
      },
      "metadata": {},
      "name": "example",
      "updated_at": "example"
    }
  }
}
```

### List clients

List clients.

**Inputs**

- Organization (`organization_id`, number, required): Organization id.
- Page Start Id (`page_start_id`, number): The page start ID. Default: `0`.
- Page Limit (`page_limit`, number): The default page size
- Status (`status`, text): Client status. One of: `active`, `archived`, `all`. Default: `active`.
- Include (`include`, list): Specify related data to side load. One or more of: `projects`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "clients": []
  }
}
```

### List job sites

List job sites.

**Inputs**

- Organization (`organization_id`, number, required): Organization id.
- Page Start Id (`page_start_id`, number): The page start ID. Default: `0`.
- Page Limit (`page_limit`, number): The default page size
- Created Start (`created_start`, date and time): Start time (ISO 8601)
- Created Stop (`created_stop`, date and time): Stop time (ISO 8601, Exclusive)

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "job_sites": []
  }
}
```

### List members

List members.

**Inputs**

- Organization (`organization_id`, number, required): Organization id.
- Page Start Id (`page_start_id`, number): The page start ID. Default: `0`.
- Page Limit (`page_limit`, number): The default page size
- Search Email (`search_email`, text): An email to search for members
- Search Name (`search_name`, text): A name to search for members
- Include Removed (`include_removed`, true/false): Include members that were removed from the organization. Default: `false`.
- Include Profile (`include_profile`, true/false): Include member profile information. Default: `false`.
- Include Projects (`include_projects`, true/false): Include project memberships for this member. Default: `false`.
- Project Statuses (`project_statuses`, list): Filter projects by status when include_projects=true. One or more of: `active`, `archived`, `deleted`.
- Include Limits (`include_limits`, true/false): Include member limits information. Default: `false`.
- Membership Roles (`membership_roles`, list): Search by membership role. One or more of: `owner`, `manager`, `user`, `unassigned`.
- Invite Link Id (`invite_link_id`, number): Filter members who joined via the given invite link
- Created At Start (`created_at_start`, date and time): Start date for created_at filter (inclusive)
- Created At Stop (`created_at_stop`, date and time): End date for created_at filter (exclusive)
- Updated At Start (`updated_at_start`, date and time): Start date for updated_at filter (inclusive)
- Updated At Stop (`updated_at_stop`, date and time): End date for updated_at filter (exclusive)
- User Ids (`user_ids`, list): List of user IDs
- Include (`include`, list): Specify related data to side load. One or more of: `users`, `projects`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "members": []
  }
}
```

### List notes

List notes.

**Inputs**

- Organization (`organization_id`, number, required): Organization id.
- Page Start Id (`page_start_id`, number): The page start ID. Default: `0`.
- Page Limit (`page_limit`, number): The default page size
- Time Slot Start (`time_slot_start`, date and time, required): Start time (ISO 8601)
- Time Slot Stop (`time_slot_stop`, date and time, required): Stop time (ISO 8601, Exclusive)
- User Ids (`user_ids`, list): List of user IDs
- Task Ids (`task_ids`, list): List of task IDs
- Project Ids (`project_ids`, list): List of project IDs
- Include (`include`, list): Specify related data to side load. One or more of: `users`, `projects`, `tasks`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "notes": []
  }
}
```

### List organizations

List organizations.

**Inputs**

- Page Start Id (`page_start_id`, number): The page start ID. Default: `0`.
- Page Limit (`page_limit`, number): The default page size

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "organizations": []
  }
}
```

### List project tasks

List project tasks.

**Inputs**

- Project Id (`project_id`, number, required): Project id.
- Page Start Id (`page_start_id`, number): The page start ID. Default: `0`.
- Page Limit (`page_limit`, number): The default page size
- Status (`status`, list): A status or list of statuses to filter. One or more of: `active`, `completed`, `deleted`, `archived`, `archived_native_active` (Archived native active), `archived_native_completed` (Archived native completed), `archived_native_deleted` (Archived native deleted).
- User Ids (`user_ids`, list): List of user IDs
- Global Todo Ids (`global_todo_ids`, list): List of Global To-Do IDs
- Only Global Todos (`only_global_todos`, true/false): Return only global to-dos
- Include (`include`, list): Specify related data to side load. One or more of: `users`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "tasks": []
  }
}
```

### List projects

List projects.

**Inputs**

- Organization (`organization_id`, number, required): Organization id.
- Page Start Id (`page_start_id`, number): The page start ID. Default: `0`.
- Page Limit (`page_limit`, number): The default page size
- Status (`status`, text): Project status. One of: `active`, `archived`, `all`. Default: `active`.
- Include (`include`, list): Specify related data to side load. One or more of: `clients`.
- Project Ids (`project_ids`, list): List of project IDs

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "projects": []
  }
}
```

### List tasks

List tasks.

**Inputs**

- Organization (`organization_id`, number, required): Organization id.
- Page Start Id (`page_start_id`, number): The page start ID. Default: `0`.
- Page Limit (`page_limit`, number): The default page size
- Status (`status`, list): A status or list of statuses to filter. One or more of: `active`, `completed`, `deleted`, `archived`, `archived_native_active` (Archived native active), `archived_native_completed` (Archived native completed), `archived_native_deleted` (Archived native deleted).
- User Ids (`user_ids`, list): List of user IDs
- Project Ids (`project_ids`, list): List of project IDs
- Global Todo Ids (`global_todo_ids`, list): List of Global To-Do IDs
- Only Global Todos (`only_global_todos`, true/false): Return only global to-dos
- Include (`include`, list): Specify related data to side load. One or more of: `users`, `projects`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "tasks": []
  }
}
```

### List teams

List teams.

**Inputs**

- Organization (`organization_id`, number, required): Organization id.
- Page Start Id (`page_start_id`, number): The page start ID. Default: `0`.
- Page Limit (`page_limit`, number): The default page size

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "teams": []
  }
}
```

### List time off requests

List time off requests.

**Inputs**

- Organization (`organization_id`, number, required): Organization id.
- Page Start Id (`page_start_id`, number): The page start ID. Default: `0`.
- Page Limit (`page_limit`, number): The default page size
- Created Start (`created_start`, date and time): Start time (ISO 8601)
- Created Stop (`created_stop`, date and time): Stop time (ISO 8601, Exclusive)
- Starts At Start (`starts_at_start`, date and time): Start time (ISO 8601)
- Starts At Stop (`starts_at_stop`, date and time): Stop time (ISO 8601, Exclusive)
- Approved At Start (`approved_at_start`, date and time): Approved start time (ISO 8601)
- Approved At Stop (`approved_at_stop`, date and time): Approved stop time (ISO 8601, Exclusive)
- User Ids (`user_ids`, list): List of user IDs
- Include (`include`, list): Specify related data to side load. One or more of: `users`, `time_off_policies` (Time off policies).

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "time_off_requests": []
  }
}
```

### List timesheets

List timesheets.

**Inputs**

- Organization (`organization_id`, number, required): Organization id.
- Page Start Id (`page_start_id`, number): The page start ID. Default: `0`.
- Page Limit (`page_limit`, number): The default page size
- Date Start (`date_start`, date): Start date (ISO 8601)
- Date Stop (`date_stop`, date): Stop date (ISO 8601, Inclusive)
- Approved Start (`approved_start`, date): Includes timesheets approved since the specified start date, considering UTC timezone (ISO 8601)
- Status (`status`, text): Invoice status. One of: `open`, `submitted`, `approved`, `denied`.
- Include (`include`, list): Specify related data to side load. One or more of: `users`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "timesheets": []
  }
}
```
