toggl / toggl_api_docs

Documentation for the Toggl API
1.39k stars 235 forks source link

Undocumented Workspace properties #315

Closed AuHau closed 2 years ago

AuHau commented 6 years ago

Hey there,

I am currently working on rewriting: https://github.com/drobertadams/toggl-cli And while the work I discovered that there are quite some properties which are undocumented. I add the documented JSON vs JSON which you get now.

Current JSON:

{
    "id": 12345678,
    "name": "Test's workspace",
    "profile": 0,
    "premium": false,
    "admin": true,
    "default_hourly_rate": 0,
    "default_currency": "USD",
    "only_admins_may_create_projects": false,
    "only_admins_see_billable_rates": false,
    "only_admins_see_team_dashboard": false,
    "projects_billable_by_default": true,
    "rounding": 1,
    "rounding_minutes": 0,
    "api_token": "XXXX",
    "at": "2017-11-21T11:33:56+00:00",
    "ical_enabled": true
  }

Documented JSON:

  {
    "id": 3134975,
    "name": "John's personal ws",
    "premium": true,
    "admin": true,
    "default_hourly_rate": 50,
    "default_currency": "USD",
    "only_admins_may_create_projects": false,
    "only_admins_see_billable_rates": true,
    "rounding": 1,
    "rounding_minutes": 15,
    "at": "2013-08-28T16:22:21+00:00",
    "logo_url": "my_logo.png"
  }

Most of the properties I can guess what they are for, but two of them are not really clear to me api_token and profile.

chrisaligent commented 5 years ago

I'm seeing profile when I query the workspaces endpoint, but I'm not seeing api_token.

Actually, it looks like api_token exists in /api/v9/workspaces, but not in /api/v8/workspaces. It's null, probably because I'm using basic auth.

I believe profile is the current Plan (Free, Starter, Premium), which you can get from: https://www.toggl.com/api/v9/workspaces/(WORKSPACE_ID)/plans (I don't think it exists in the v8 API)

geoffreywiseman commented 4 years ago

I'm seeing profile in the v8 API response, and api_token, and several boolean flags that aren't in the documentation.

joeriharleman commented 2 years ago

Hello @AuHau!

Thank you for submitting your issue. Unfortunately this repository is largely unmaintained, which means issues remain unseen and do not get dealt with in a respectable manner. We're sorry for not getting back to you sooner.

This issue has been around for a long time so we will close it for now, but please let our excellent 24/5 support staff know you if you have any unresolved issues with our platform, documentation or APIs. They're also really good at noting down feature requests for our development teams. Please find them on our support page by clicking the little icon in the bottom right corner of the screen.

Kind regards, Joeri from Toggl