Hubstaff

App · 20 actions

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

Actions

ActionWhat it does
Create projectCreate project.
Create taskCreate task.
Delete taskDelete task.
Get clientGet client.
Get current userGet current user.
Get organizationGet organization.
Get projectGet project.
Get taskGet task.
Get teamGet team.
List clientsList clients.
List job sitesList job sites.
List membersList members.
List notesList notes.
List organizationsList organizations.
List project tasksList project tasks.
List projectsList projects.
List tasksList tasks.
List teamsList teams.
List time off requestsList time off requests.
List timesheetsList timesheets.

Create project

Create project.

Inputs

Organizationorganization_idnumberRequired
Organization id.
NamenametextRequired
Project name
Descriptiondescriptiontext
Project description
Metadatametadatalist
Project metadata. See the update_metadata endpoint
Membersmemberslist
Members.
Client Idclient_idnumber
The client ID
Billablebillabletrue/false
Whether activity logged against this project is billable by default (default is true)
Budget Typebudget_typetext
The method for controlling the budgetOne of: cost, hours.
Budget Ratebudget_ratetext
When budget type is cost, specifies which rate to use.One of: bill_rate (Bill rate), pay_rate (Pay rate). Default: bill_rate.
Budget Costbudget_costnumber
When budget type is cost. defines the cost limit.
Budget Hoursbudget_hoursnumber
When budget type is hours. defines the hours limit.
Budget Start Datebudget_start_datedate
The start date for the budget.
Budget Recurrencebudget_recurrencetext
If given, makes budget reset on a weekly or monthly basisOne of: weekly, monthly.
Budget Recurrence Startbudget_recurrence_startnumber
Day of week (0-6, 0=Sunday) for weekly recurrence, or day of month (1-31) for monthly recurrence
Budget Include Non Billablebudget_include_non_billabletrue/false
Whether the budget includes non billable timeDefault: true.
Budget Stop Timer When Budget Reachedbudget_stop_timer_when_budget_reachedtrue/false
Whether to stop timers when budget limit is reached
Budget Stop Atbudget_stop_atnumber
The budget percentage at which timers stop automatically
Budget Alerts Near Limitbudget_alerts_near_limitnumber
The percentage threshold for notifying when approaching the budget.
Budget Alerts Notify Enabledbudget_alerts_notify_enabledtrue/false
Whether budget notifications are enabled
Budget Alerts Notify All Membersbudget_alerts_notify_all_memberstrue/false
Whether to notify all project members
Budget Alerts Notify Groupbudget_alerts_notify_grouptext
The group to notifyOne of: all_members (All members), org_management (Org management).
Pay Ratepay_ratenumber
Default pay rate (will be rounded to 2 decimal places). Set to null to remove the rate
Bill Ratebill_ratenumber
Default bill rate (will be rounded to 2 decimal places). Set to null to remove the rate

Outputs

dataobject
Response.
Example output
{
  "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 Idproject_idnumberRequired
Project id.
Assignee Idassignee_idnumber
Assignee Id
Assignee Idsassignee_idslist
Assignee Ids
SummarysummarytextRequired
To-do summary
Pay Ratepay_ratenumber
Pay rate. Set to null to remove
Bill Ratebill_ratenumber
Bill rate. Set to null to remove
Metadatametadatalist
Task metadata. See the update_metadata endpoint

Outputs

dataobject
Response.
Example output
{
  "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 Idtask_idnumberRequired
Task ID

Outputs

dataobject
Response.
Example output
{
  "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 Idclient_idnumberRequired
Client ID

Outputs

dataobject
Response.
Example output
{
  "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

dataobject
Response.
Example output
{
  "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

Organizationorganization_idnumberRequired
Organization ID

Outputs

dataobject
Response.
Example output
{
  "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 Idproject_idnumberRequired
Project ID

Outputs

dataobject
Response.
Example output
{
  "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 Idtask_idnumberRequired
Task ID

Outputs

dataobject
Response.
Example output
{
  "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 Idvendor_team_idnumberRequired
Team ID

Outputs

dataobject
Response.
Example output
{
  "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

Organizationorganization_idnumberRequired
Organization id.
Page Start Idpage_start_idnumber
The page start ID.Default: 0.
Page Limitpage_limitnumber
The default page size
Statusstatustext
Client statusOne of: active, archived, all. Default: active.
Includeincludelist
Specify related data to side load.One or more of: projects.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "clients": []
  }
}

List job sites

List job sites.

Inputs

Organizationorganization_idnumberRequired
Organization id.
Page Start Idpage_start_idnumber
The page start ID.Default: 0.
Page Limitpage_limitnumber
The default page size
Created Startcreated_startdate and time
Start time (ISO 8601)
Created Stopcreated_stopdate and time
Stop time (ISO 8601, Exclusive)

Outputs

dataobject
Response.
Example output
{
  "data": {
    "job_sites": []
  }
}

List members

List members.

Inputs

Organizationorganization_idnumberRequired
Organization id.
Page Start Idpage_start_idnumber
The page start ID.Default: 0.
Page Limitpage_limitnumber
The default page size
Search Emailsearch_emailtext
An email to search for members
Search Namesearch_nametext
A name to search for members
Include Removedinclude_removedtrue/false
Include members that were removed from the organizationDefault: false.
Include Profileinclude_profiletrue/false
Include member profile informationDefault: false.
Include Projectsinclude_projectstrue/false
Include project memberships for this memberDefault: false.
Project Statusesproject_statuseslist
Filter projects by status when include_projects=trueOne or more of: active, archived, deleted.
Include Limitsinclude_limitstrue/false
Include member limits informationDefault: false.
Membership Rolesmembership_roleslist
Search by membership roleOne or more of: owner, manager, user, unassigned.
Invite Link Idinvite_link_idnumber
Filter members who joined via the given invite link
Created At Startcreated_at_startdate and time
Start date for created_at filter (inclusive)
Created At Stopcreated_at_stopdate and time
End date for created_at filter (exclusive)
Updated At Startupdated_at_startdate and time
Start date for updated_at filter (inclusive)
Updated At Stopupdated_at_stopdate and time
End date for updated_at filter (exclusive)
User Idsuser_idslist
List of user IDs
Includeincludelist
Specify related data to side load.One or more of: users, projects.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "members": []
  }
}

List notes

List notes.

Inputs

Organizationorganization_idnumberRequired
Organization id.
Page Start Idpage_start_idnumber
The page start ID.Default: 0.
Page Limitpage_limitnumber
The default page size
Time Slot Starttime_slot_startdate and timeRequired
Start time (ISO 8601)
Time Slot Stoptime_slot_stopdate and timeRequired
Stop time (ISO 8601, Exclusive)
User Idsuser_idslist
List of user IDs
Task Idstask_idslist
List of task IDs
Project Idsproject_idslist
List of project IDs
Includeincludelist
Specify related data to side load.One or more of: users, projects, tasks.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "notes": []
  }
}

List organizations

List organizations.

Inputs

Page Start Idpage_start_idnumber
The page start ID.Default: 0.
Page Limitpage_limitnumber
The default page size

Outputs

dataobject
Response.
Example output
{
  "data": {
    "organizations": []
  }
}

List project tasks

List project tasks.

Inputs

Project Idproject_idnumberRequired
Project id.
Page Start Idpage_start_idnumber
The page start ID.Default: 0.
Page Limitpage_limitnumber
The default page size
Statusstatuslist
A status or list of statuses to filterOne 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 Idsuser_idslist
List of user IDs
Global Todo Idsglobal_todo_idslist
List of Global To-Do IDs
Only Global Todosonly_global_todostrue/false
Return only global to-dos
Includeincludelist
Specify related data to side load.One or more of: users.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "tasks": []
  }
}

List projects

List projects.

Inputs

Organizationorganization_idnumberRequired
Organization id.
Page Start Idpage_start_idnumber
The page start ID.Default: 0.
Page Limitpage_limitnumber
The default page size
Statusstatustext
Project statusOne of: active, archived, all. Default: active.
Includeincludelist
Specify related data to side load.One or more of: clients.
Project Idsproject_idslist
List of project IDs

Outputs

dataobject
Response.
Example output
{
  "data": {
    "projects": []
  }
}

List tasks

List tasks.

Inputs

Organizationorganization_idnumberRequired
Organization id.
Page Start Idpage_start_idnumber
The page start ID.Default: 0.
Page Limitpage_limitnumber
The default page size
Statusstatuslist
A status or list of statuses to filterOne 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 Idsuser_idslist
List of user IDs
Project Idsproject_idslist
List of project IDs
Global Todo Idsglobal_todo_idslist
List of Global To-Do IDs
Only Global Todosonly_global_todostrue/false
Return only global to-dos
Includeincludelist
Specify related data to side load.One or more of: users, projects.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "tasks": []
  }
}

List teams

List teams.

Inputs

Organizationorganization_idnumberRequired
Organization id.
Page Start Idpage_start_idnumber
The page start ID.Default: 0.
Page Limitpage_limitnumber
The default page size

Outputs

dataobject
Response.
Example output
{
  "data": {
    "teams": []
  }
}

List time off requests

List time off requests.

Inputs

Organizationorganization_idnumberRequired
Organization id.
Page Start Idpage_start_idnumber
The page start ID.Default: 0.
Page Limitpage_limitnumber
The default page size
Created Startcreated_startdate and time
Start time (ISO 8601)
Created Stopcreated_stopdate and time
Stop time (ISO 8601, Exclusive)
Starts At Startstarts_at_startdate and time
Start time (ISO 8601)
Starts At Stopstarts_at_stopdate and time
Stop time (ISO 8601, Exclusive)
Approved At Startapproved_at_startdate and time
Approved start time (ISO 8601)
Approved At Stopapproved_at_stopdate and time
Approved stop time (ISO 8601, Exclusive)
User Idsuser_idslist
List of user IDs
Includeincludelist
Specify related data to side load.One or more of: users, time_off_policies (Time off policies).

Outputs

dataobject
Response.
Example output
{
  "data": {
    "time_off_requests": []
  }
}

List timesheets

List timesheets.

Inputs

Organizationorganization_idnumberRequired
Organization id.
Page Start Idpage_start_idnumber
The page start ID.Default: 0.
Page Limitpage_limitnumber
The default page size
Date Startdate_startdate
Start date (ISO 8601)
Date Stopdate_stopdate
Stop date (ISO 8601, Inclusive)
Approved Startapproved_startdate
Includes timesheets approved since the specified start date, considering UTC timezone (ISO 8601)
Statusstatustext
Invoice statusOne of: open, submitted, approved, denied.
Includeincludelist
Specify related data to side load.One or more of: users.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "timesheets": []
  }
}

On this page