---
title: "Get a list of goals"
method: GET
path: "/goals"
tags: ["goals"]
---

# Get a list of goals

`GET /goals`

## Request

- Base URL: `https://localhost:8080/api/v9`
- URL: `https://localhost:8080/api/v9/goals`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/toggl/apis/toggl-api/docs/goals/get.ts> (a function with typed inputs; its response is checked against the schema)

Gets all goals for the requesting user. The returned Goal will have only one type, but may have multiple
on the same type, like 3 projects, or more than one task. Billable will always be one.

## Query parameters

- `archived` string
- `workspace_id` integer

## Response `200`

List of goals for a given user

- ModelsPlainGoal[]
  - `archived` boolean
  - `archived_at` string
  - `cadence_period` string
  - `comparing` string
  - `current_cadence` ModelsGoalCadence
    - `achieved` boolean
    - `cadence_end` string
    - `cadence_start` string
    - `goal_cadence_id` integer
    - `goal_parameter_id` integer
    - `streak` integer
    - `tracked_value` integer
  - `description` string
  - `end` string
  - `goal_id` integer
  - `goal_parameter_id` integer
  - `goal_type` ModelsGoalType
    - `billable` boolean: For simplicity's sake we will not use GoalBillableType here
    - `projects` ModelsGoalProjectType[]
      - `project_id` integer
      - `task_id` integer
  - `icon` integer
  - `icon_color` string
  - `name` string
  - `start` string
  - `target_value` integer
  - `type_name` string
  - `user_id` integer
  - `workspace_id` integer

## Other responses

- `403`: User has no access to Goals feature
- `500`: Internal Server Error

---

[API](https://skmtc.dev/toggl/apis/toggl-api.md) - [All operations](https://skmtc.dev/toggl/apis/toggl-api/llms.txt) - [OpenAPI document](https://skmtc.dev/toggl/apis/toggl-api/revisions/3085aee16990?raw)
