Projects · Timeglass API

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

List Projects

GET /v1/projects

Query parameters

  • limit · integer
  • cursor · string
  • client_id · string · uuid
  • team_id · string · uuid · The team’s projects plus workspace-wide projects, which every team can use.
  • include_workspace_wide · string · false leaves out workspace-wide projects. · One of: true, false
  • status · any
  • external_id · string · Matched ignoring case.

Response 200

  • data · array of object · required
    • project_id · string · uuid · required
    • title · string · required
    • description · string,null · required
    • status · any · required
    • team_id · string · uuid · nullable · required
    • client_id · string · uuid · nullable · required
    • category_id · string · uuid · nullable · required
    • external_id · string,null · required · Your own id for this record, such as its id in the tool you sync from. Unique in the workspace.
    • target_minutes · number,null · required
    • total_minutes · number · required
    • first_active_date · string,null · required
    • last_active_date · string,null · required
    • created_at · string · timestamp · required
  • next_cursor · string,null · required
curl "https://api.timeglass.ai/v1/projects" \
  -H "Authorization: Bearer $TIMEGLASS_API_KEY"

Create a Project

POST /v1/projects

Requires a key with the read_write scope.

Request body

  • title · string · required
  • team_id · string · uuid · nullable · required
  • description · string,null
  • client_id · string · uuid
  • target_minutes · integer
  • status · string · One of: active, inactive, completed, draft
  • external_id · string · Your own id for this record, such as its id in the tool you sync from. Unique in the workspace.

Response 201

  • project · object · required
    • project_id · string · uuid · required
    • title · string · required
    • description · string,null · required
    • status · any · required
    • team_id · string · uuid · nullable · required
    • client_id · string · uuid · nullable · required
    • category_id · string · uuid · nullable · required
    • external_id · string,null · required · Your own id for this record, such as its id in the tool you sync from. Unique in the workspace.
    • target_minutes · number,null · required
    • total_minutes · number · required
    • first_active_date · string,null · required
    • last_active_date · string,null · required
    • created_at · string · timestamp · required
curl -X POST "https://api.timeglass.ai/v1/projects" \
  -H "Authorization: Bearer $TIMEGLASS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Aviation account expansion",
    "team_id": "4bfe4a4b-c86b-4b8e-b3f5-3d1c4a2e9f10"
  }'

Get a Project

GET /v1/projects/{projectId}

Path parameters

  • projectId · string · uuid · required

Response 200

  • project_id · string · uuid · required
  • title · string · required
  • description · string,null · required
  • status · any · required
  • team_id · string · uuid · nullable · required
  • client_id · string · uuid · nullable · required
  • category_id · string · uuid · nullable · required
  • external_id · string,null · required · Your own id for this record, such as its id in the tool you sync from. Unique in the workspace.
  • target_minutes · number,null · required
  • total_minutes · number · required
  • first_active_date · string,null · required
  • last_active_date · string,null · required
  • created_at · string · timestamp · required
curl "https://api.timeglass.ai/v1/projects/4bfe4a4b-c86b-4b8e-b3f5-3d1c4a2e9f10" \
  -H "Authorization: Bearer $TIMEGLASS_API_KEY"

Update a Project

PATCH /v1/projects/{projectId}

Requires a key with the read_write scope.

Path parameters

  • projectId · string · uuid · required

Request body

  • title · string
  • description · string,null
  • status · string · One of: active, inactive, completed, draft
  • team_id · string · uuid · nullable
  • client_id · string · uuid · nullable
  • target_minutes · integer
  • external_id · string · nullable · Your own id for this record, such as its id in the tool you sync from. Unique in the workspace.

Response 200

  • project · object · required
    • project_id · string · uuid · required
    • title · string · required
    • description · string,null · required
    • status · any · required
    • team_id · string · uuid · nullable · required
    • client_id · string · uuid · nullable · required
    • category_id · string · uuid · nullable · required
    • external_id · string,null · required · Your own id for this record, such as its id in the tool you sync from. Unique in the workspace.
    • target_minutes · number,null · required
    • total_minutes · number · required
    • first_active_date · string,null · required
    • last_active_date · string,null · required
    • created_at · string · timestamp · required
curl -X PATCH "https://api.timeglass.ai/v1/projects/4bfe4a4b-c86b-4b8e-b3f5-3d1c4a2e9f10" \
  -H "Authorization: Bearer $TIMEGLASS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Delete a Project

DELETE /v1/projects/{projectId}

Requires a key with the read_write scope.

Path parameters

  • projectId · string · uuid · required
curl -X DELETE "https://api.timeglass.ai/v1/projects/4bfe4a4b-c86b-4b8e-b3f5-3d1c4a2e9f10" \
  -H "Authorization: Bearer $TIMEGLASS_API_KEY"