Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WakaTime Custom Rules API

User and organization custom-rule definitions for time attribution.

WakaTime Custom Rules API is one of 20 APIs that WakaTime publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Custom Rules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a changelog, a status page, and 4 JSON Schemas.

This API exposes 5 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against 2 base URLs: https://wakatime.com/api/v1, https://api.wakatime.com/api/v1.

5 operations 3 paths 2 schemas 2 DELETE2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://wakatime.com/api/v1/
Authentication
OAuth 2.0, HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 3

WakaTime Custom Rules API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode and implicit flows, exposing 8 scopes. It accepts HTTP basic authentication (apiKey). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 authorization code flow.
  • apiKey — HTTP Basic with the WakaTime API key as the username. Alternatively, pass ?apikey=... as a query parameter.
  • bearerAuth — OAuth access token in the Authorization header as Bearer wakatok....

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 DELETE, 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Rules 5

User and organization custom-rule definitions for time attribution.

GET
/users/current/custom_rules
List Custom Rules
listCustomRules → 200
PUT
/users/current/custom_rules
Put Custom Rules
putCustomRules body → 200
DELETE
/users/current/custom_rules/{rule_id}
Delete Custom Rule
deleteCustomRule 1 param → 204
GET
/users/current/custom_rules_progress
Get Custom Rules Progress
getCustomRulesProgress → 200
DELETE
/users/current/custom_rules_progress
Abort Custom Rules Progress
abortCustomRulesProgress → 204

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is CustomRuleInput (4 properties). Each schema is shown below with its type and property counts.

CustomRuleInput
object
4 properties
CustomRule

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wakatime-custom-rules-api-openapi.yml Raw ↑

Other APIs WakaTime publishes across the network.

WakaTime Commits API
WakaTime Data Dumps API
WakaTime Durations API
WakaTime Editors API
WakaTime External Durations API
WakaTime Goals API
WakaTime Heartbeats API
WakaTime Insights API
WakaTime Languages API
WakaTime Leaderboards API
WakaTime Machines API
WakaTime Meta API