Timeglass API documentation

REST API v1.0.0 over Timeglass workspace data: members, teams, departments, clients, projects, activity categories, tracked activities, timesheets, reports, and meetings.

Authentication

Workspace admins create API keys in workspace settings. Keys carry a read or read_write scope and are sent as a bearer token: Authorization: Bearer tg_live_...

Pagination

List endpoints return { "data": [...], "next_cursor": "..." }. Pass limit (1 to 200) and follow next_cursor until it is null.

Errors and rate limits

Errors use the envelope { "error": { "code": "...", "message": "..." } }. Each key may make 300 requests per minute.

Workspace

The workspace behind your API key, and the key itself.

  • GET /v1/workspace: Get the workspace

Directory

Members, teams, and departments: the people and structure of the workspace.

  • GET /v1/members: List members
  • GET /v1/members/{memberId}: Get a member
  • GET /v1/teams: List teams
  • GET /v1/teams/{teamId}: Get a team
  • GET /v1/departments: List departments
  • GET /v1/departments/{departmentId}: Get a department

Clients

Create, rename, archive, and restore the clients that projects belong to.

  • GET /v1/clients: List clients
  • POST /v1/clients: Create a client
  • PATCH /v1/clients/{clientId}: Update a client

Projects

Manage projects, their teams, clients, budgets, and lifecycle.

  • GET /v1/projects: List projects
  • POST /v1/projects: Create a project
  • GET /v1/projects/{projectId}: Get a project
  • PATCH /v1/projects/{projectId}: Update a project
  • DELETE /v1/projects/{projectId}: Delete a project

Activity Categories

The two-level category tree used to classify tracked activities.

  • GET /v1/activity-categories: List activity categories
  • POST /v1/activity-categories: Create an activity category
  • PATCH /v1/activity-categories/{categoryId}: Update an activity category
  • DELETE /v1/activity-categories/{categoryId}: Delete an activity category
  • POST /v1/activity-categories/{categoryId}/archive: Archive an activity category
  • POST /v1/activity-categories/{categoryId}/restore: Restore an activity category

Time Data

Tracked activities, their fine-grained items, and member-day timesheets built from them.

  • GET /v1/activities: List activities
  • GET /v1/activities/{activityId}: Get an activity
  • GET /v1/activities/{activityId}/items: List activity items
  • GET /v1/timesheets: List timesheets

Meetings

Meetings, participants, and per-minute transcripts.

  • GET /v1/meetings: List meetings
  • GET /v1/meetings/{meetingId}: Get a meeting with participants
  • GET /v1/meetings/{meetingId}/transcript: Get a meeting transcript

The machine-readable OpenAPI document is at api.timeglass.ai/openapi.json.