HubstaffDeveloper Portal

App and url tracking settings

Read and batch-update the Track Apps & URLs setting for members

Recent changes (1)
  1. Breaking change

    Public API available on all plans

    The Public API is no longer restricted by plan, and the error code for plan-restricted features changed from 10005 to 10006.

    Plan requirement
    Was: Organization-scoped endpoints required a Team or Enterprise plan, for organizations subject to the restrictionNow: No plan requirement
    Organization access tokens
    Was: Could not be created on a plan without API access, for the same organizationsNow: Can be created on any plan
    Error code 10005 (plan_restricted)
    Was: Returned when the plan did not include API accessNow: Retired; no longer returned
    Error code 10006 (feature_not_available)
    Was: Returned by other feature checksNow: Also returned by screenshot settings, app & URL tracking settings and overtime policies

    Organization-scoped endpoints and organization access tokens no longer check the organization’s plan, so requests that previously failed with 403 plan_restricted now succeed. The restriction never applied to every account — organizations that predated it kept access regardless of plan — so you may see no change. Rate limits are unchanged.

    Three endpoints still require the plan to include the underlying feature — screenshot settings, app & URL tracking settings, and overtime policies. They now answer 403 with code: "feature_not_available" and error_code: 10006 instead of code: "plan_restricted" and error_code: 10005. If your integration branches on 10005 or on plan_restricted, update it to 10006 / feature_not_available. Code 10005 is retired and will not be reused.

List member Track Apps & URLs settings

GET/v2/organizations/{organization_id}/app_and_url_tracking_settings

Returns the Track Apps & URLs setting for the organization’s members.

Results can be filtered to specific members with user_ids. When no filter is given, all members are returned.

Only organization Owners and Managers may use this endpoint.

Parameters

NameInTypeDescription
organization_idrequired
pathinteger (int32)
page_start_id
queryinteger (int32)
The page start ID.
page_limit
queryinteger (int32)
The default page size
user_ids
queryarray integer[]
List of user IDs
include
queryarray string[]
Specify related data to side load.
Possible valuesusers

Responses

200A list of member Track Apps & URLs settings
object
  • app_and_url_tracking_settingsarray
    array<object>
    items
    object

    AppAndUrlTrackingSetting model

    • user_idinteger required

      The member user ID

    • app_and_url_trackingstring required

      Track Apps & URLs setting: off, apps, or apps_and_urls

Example response
json
{
  "app_and_url_tracking_settings": [
    {
      "user_id": 0,
      "app_and_url_tracking": "string"
    }
  ]
}
400Invalid parameters
object

Hubstaff_Public_V2_Entities_Error model

  • codestring required

    Legacy string error code for backward compatibility

  • error_codeinteger

    Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.

  • errorstring required

    Human-readable error message

  • detailsarray

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    array<string>

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    items
    string
Example response
json
{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}
401Unauthorized
object

Hubstaff_Public_V2_Entities_Error model

  • codestring required

    Legacy string error code for backward compatibility

  • error_codeinteger

    Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.

  • errorstring required

    Human-readable error message

  • detailsarray

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    array<string>

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    items
    string
Example response
json
{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}
403API access is only for organizations on an active plan
object

Hubstaff_Public_V2_Entities_Error model

  • codestring required

    Legacy string error code for backward compatibility

  • error_codeinteger

    Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.

  • errorstring required

    Human-readable error message

  • detailsarray

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    array<string>

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    items
    string
Example response
json
{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}
404Could not find record
object

Hubstaff_Public_V2_Entities_Error model

  • codestring required

    Legacy string error code for backward compatibility

  • error_codeinteger

    Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.

  • errorstring required

    Human-readable error message

  • detailsarray

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    array<string>

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    items
    string
Example response
json
{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}
429Rate limit exceeded
object

Hubstaff_Public_V2_Entities_Error model

  • codestring required

    Legacy string error code for backward compatibility

  • error_codeinteger

    Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.

  • errorstring required

    Human-readable error message

  • detailsarray

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    array<string>

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    items
    string
Example response
json
{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}

Update member Track Apps & URLs settings

PUT/v2/organizations/{organization_id}/app_and_url_tracking_settings

Sets the Track Apps & URLs setting for the organization’s members.

Allowed values: off, apps, apps_and_urls. Available only to organizations whose plan includes Apps & URLs tracking.

Provide user_ids to update specific members. To change the organization-wide default instead — which cascades to every current and future member — set apply_to_all_members to true and omit user_ids. The organization-wide change is cautionary and irreversible in bulk: the response reports scope: "global", and for large organizations it is applied in the background.

user_ids and apply_to_all_members are mutually exclusive, and exactly one of them must be given (this prevents an accidental org-wide change when filters are omitted). When targeting user_ids, omit apply_to_all_members entirely — sending it as false is rejected.

Only organization Owners and Managers may use this endpoint.

Parameters

NameInTypeDescription
organization_idrequired
pathinteger (int32)

Request body

object

Update member Track Apps & URLs settings

  • app_and_url_trackingstring required

    Track Apps & URLs setting: off, apps, or apps_and_urls

  • user_idsarray

    Members to update. Mutually exclusive with apply_to_all_members.

    array<integer>

    Members to update. Mutually exclusive with apply_to_all_members.

    items
    integer(int32)
  • apply_to_all_membersboolean

    Set to true to change the organization-wide default for all current and future members. Mutually exclusive with user_ids.

Responses

200Update result
object
  • app_and_url_tracking_settingobject
    object

    AppAndUrlTrackingSetting model

    • user_idinteger required

      The member user ID

    • app_and_url_trackingstring required

      Track Apps & URLs setting: off, apps, or apps_and_urls

Example response
json
{
  "app_and_url_tracking_setting": {
    "user_id": 0,
    "app_and_url_tracking": "string"
  }
}
400Invalid parameters
object

Hubstaff_Public_V2_Entities_Error model

  • codestring required

    Legacy string error code for backward compatibility

  • error_codeinteger

    Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.

  • errorstring required

    Human-readable error message

  • detailsarray

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    array<string>

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    items
    string
Example response
json
{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}
401Unauthorized
object

Hubstaff_Public_V2_Entities_Error model

  • codestring required

    Legacy string error code for backward compatibility

  • error_codeinteger

    Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.

  • errorstring required

    Human-readable error message

  • detailsarray

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    array<string>

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    items
    string
Example response
json
{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}
403API access is only for organizations on an active plan
object

Hubstaff_Public_V2_Entities_Error model

  • codestring required

    Legacy string error code for backward compatibility

  • error_codeinteger

    Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.

  • errorstring required

    Human-readable error message

  • detailsarray

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    array<string>

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    items
    string
Example response
json
{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}
404Could not find record
object

Hubstaff_Public_V2_Entities_Error model

  • codestring required

    Legacy string error code for backward compatibility

  • error_codeinteger

    Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.

  • errorstring required

    Human-readable error message

  • detailsarray

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    array<string>

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    items
    string
Example response
json
{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}
429Rate limit exceeded
object

Hubstaff_Public_V2_Entities_Error model

  • codestring required

    Legacy string error code for backward compatibility

  • error_codeinteger

    Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.

  • errorstring required

    Human-readable error message

  • detailsarray

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    array<string>

    Per-attribute validation errors: [{attribute, error}]. Present on validation failures.

    items
    string
Example response
json
{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}