Clock

Changed on
delete/v2/clock/{id}

Request

  • Base URL
    https://my.clockodo.com/api
  • URL
    https://my.clockodo.com/api/v2/clock/{id}
  • Auth
    • HTTP basic and API key in header X-Clockodo-External-Application
    • or API key in header X-ClockodoApiUser and API key in header X-ClockodoApiKey and API key in header X-Clockodo-External-Application
    • or OAuth 2
      Authorization code: /oauth/authorize
      Token URL: /token

Path parameters

idinteger required
Example:1

Query parameters

awayinteger nullable

Seconds the user was away before stopping. The stopped entry ends this many seconds before "time_until".

start_newboolean nullable

Only takes effect together with "away" greater than 0: the clock then continues with a new running entry starting at "time_until". Defaults to true; pass false to only stop the clock. Without "away" the clock is always just stopped.

time_untilstring date-time nullable
Example:2023-02-28T12:00:00Z
users_idinteger nullable

Response

Successful operation

current_timestring date-time required
stopped_has_been_truncatedboolean required

Example response

{
  "running": {
    "id": 10,
    "customers_id": 10,
    "time_since": "2023-02-28T00:00:00Z",
    "time_insert": "2023-02-28T00:00:00Z",
    "time_last_change": "2023-02-28T00:00:00Z",
    "customers_name": "Hotel Bergblick",
    "projects_name": "Publicity campaign",
    "subprojects_name": "Social media ads",
    "users_name": "Max Mustermann",
    "revenue": 999.9,
    "time_last_change_work_time": "2023-02-28T00:00:00Z",
    "time_clocked_since": "2023-02-28T00:00:00Z",
    "hourly_rate": 99.99,
    "services_name": "SEO service"
  },
  "stopped": {
    "id": 10,
    "customers_id": 10,
    "time_since": "2023-02-28T00:00:00Z",
    "time_insert": "2023-02-28T00:00:00Z",
    "time_last_change": "2023-02-28T00:00:00Z",
    "customers_name": "Hotel Bergblick",
    "projects_name": "Publicity campaign",
    "subprojects_name": "Social media ads",
    "users_name": "Max Mustermann",
    "revenue": 999.9,
    "time_last_change_work_time": "2023-02-28T00:00:00Z",
    "time_clocked_since": "2023-02-28T00:00:00Z",
    "hourly_rate": 99.99,
    "services_name": "SEO service",
    "time_until": "2023-02-28T00:00:00Z"
  },
  "current_time": "2023-02-28T00:00:00.000Z"
}

Changes

  • 0f27ed36400cRevision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the response's property type changed from no type to object for status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      added the required property /// to the response with the status

  • ceedd6dd3446Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response property allOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed subschema #2 from the response property oneOf list for the response status