---
title: "List Public Goals"
method: GET
path: "/v2/public/goals"
tags: ["goals"]
---

# List Public Goals

`GET /v2/public/goals`

## Request

- Base URL: `https://api.sanka.com`
- URL: `https://api.sanka.com/v2/public/goals`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sankahq/apis/sanka-public-api/docs/v2/public/goals/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `page` integer
- `limit` integer
- `language` string, nullable
- `workspace_id` string, nullable

## Headers

- `X-Workspace-Code` string

## Response `200`

Successful Response

- ListPublicGoals200Envelope
  - `success` true, required
  - `data` GoalListData, required
    - `items` GoalListItem[], required
      - `goal` GoalData, required
        - `id` string, uuid, required
        - `name` string, required
        - `metric` 'deals_created' | 'invoice_revenue' | 'custom', required
        - `unit` 'count' | 'money' | 'number', required
        - `source` string, required
        - `definition` GoalMetricDefinition, required: What a goal counts or sums: one object's active records, by the month of one of their dates, narrowed by filters (the same expressions as saved views).
          - `source` string, required
          - `measure` string
          - `date_field` string
          - `filters` SearchFilterExpression[]
            - `field` FieldReference, required
              - …
            - `operator` 'equals' | 'not_equals' | 'contains' | 'does_not_contain' | 'starts_with' | 'ends_with' | 'in' | 'not_in' | 'is_empty' | 'is_not_empty' | 'greater_than' | 'greater_than_or_equal' | 'less_than' | 'less_than_or_equal' | 'between' | 'equal_or_after_today' | 'equal_or_before_today' | 'last_x_days' | 'more_than_x_days', required
            - `value` unknown
            - `selected_label` string, nullable
        - `amount` 'before_tax' | 'including_tax', nullable, required
        - `currency` string, nullable, required
        - `assignment` 'company' | 'people' | 'company_and_people', required
        - `assignees` GoalOwner[], required
          - `id` integer, required
          - `label` string, required
        - `version` integer, required
        - `archived` boolean, required
        - `created_at` string, date-time, required
        - `updated_at` string, date-time, required
      - `this_month` GoalPeriodProgress, required
        - `key` 'month' | 'quarter' | 'half' | 'year', required
        - `start` string, date, required
        - `end` string, date, required
        - `actual` string, required
        - `target` string, nullable, required
        - `expected` string, nullable, required
    - `total` integer, required
    - `can_edit` boolean, required
    - `fiscal_year_start_month` integer, required
    - `default_currency` string, required
  - `meta` EnvelopeMeta, required
    - `ctx_id` string, required
    - `pagination` PaginationMeta
      - `page` integer, required
      - `page_size` integer, required
      - `total` integer, required
      - `next_cursor` string, nullable
    - `toast` ToastMessage
      - `variant` 'success' | 'error' | 'info' | 'warning', required
      - `code` string, required
      - `message` string, required
      - `i18n` ToastMessageI18n, required
        - `en` string, required
        - `ja` string, required

## Other responses

- `401`: Error response
- `422`: Error response

## Changes

- **2026-10-05** `0ae44d305596`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sankahq/apis/sanka-public-api/changes/v2/public/goals/get.md)

---

[API](https://skmtc.dev/sankahq/apis/sanka-public-api.md) - [All operations](https://skmtc.dev/sankahq/apis/sanka-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sankahq/apis/sanka-public-api/revisions/16f03a9e3ab9?raw)