> ## Documentation Index > Fetch the complete documentation index at: https://docs.visorfinance.app/llms.txt > Use this file to discover all available pages before exploring further. # List goals > Returns the savings goals of a space, newest first, with the same amounts and progress the app shows. The emergency fund is a goal with `kind` `emergency_fund`. Archived goals are left out unless you ask for them with `status=archived`. Requires the `pfm:read` scope. ## OpenAPI ````yaml /openapi.json get /v1/spaces/{space_id}/goals openapi: 3.0.3 info: description: >- Personal REST API for Visor Pro and Premium users. Authenticate with a personal API token created in Visor Settings, sent as `Authorization: Bearer visor_pat_...`, or with an OAuth access token from the Visor CLI browser login. title: Visor Personal API version: 1.0.0 servers: - url: https://api.visorfinance.app variables: {} security: - personal_api_token: [] - visor_cli_oauth: - pfm:read tags: [] paths: /v1/spaces/{space_id}/goals: get: tags: - Goals summary: List goals description: >- Returns the savings goals of a space, newest first, with the same amounts and progress the app shows. The emergency fund is a goal with `kind` `emergency_fund`. Archived goals are left out unless you ask for them with `status=archived`. Requires the `pfm:read` scope. operationId: VisorWeb.Api.V1.GoalController.index parameters: - description: A space `id` from `GET /v1/spaces` in: path name: space_id required: true schema: format: uuid type: string - description: >- Return only goals with this status. Without it, active and completed goals are returned. in: query name: status required: false schema: enum: - active - archived - completed type: string responses: '200': content: application/json: example: data: - created_at: '2026-03-14T12:00:00Z' currency_code: BRL current_amount: '2500.5' id: 7c1d9e42-5b3a-4f08-a6d2-3e9b8f1c0a57 kind: generic name: Viagem para Lisboa progress_percent: 25 status: active target_amount: '10000' target_date: '2027-06-30' schema: $ref: '#/components/schemas/GoalListResponse' description: Goals of the space headers: x-ratelimit-limit: description: Requests allowed for this token per minute schema: example: 60 type: integer style: simple x-ratelimit-remaining: description: Requests left for this token in the current minute schema: example: 59 type: integer style: simple x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '400': content: application/json: example: errors: - code: BAD_REQUEST details: parameter: include_hidden message: The request is malformed. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: A query parameter has an invalid value headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '401': content: application/json: example: errors: - code: INVALID_TOKEN details: {} message: The personal API token is not valid. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: Missing, invalid, expired, or revoked token headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '403': content: application/json: example: errors: - code: INSUFFICIENT_SCOPE details: required_scope: pfm:read message: The personal API token does not grant this operation. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: Pro or Premium plan required, or insufficient scope headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '404': content: application/json: example: errors: - code: NOT_FOUND details: {} message: The resource does not exist. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: The space does not exist or the token's user cannot access it headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '406': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: The client does not accept JSON headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '429': content: application/json: example: errors: - code: RATE_LIMITED details: retry_after_seconds: 42 message: >- Too many requests. Retry after the number of seconds in Retry-After. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: Rate limit exceeded headers: retry-after: description: Seconds until the current window ends schema: example: 42 type: integer style: simple x-ratelimit-limit: description: Requests allowed for this token per minute schema: example: 60 type: integer style: simple x-ratelimit-remaining: description: Requests left for this token in the current minute schema: example: 59 type: integer style: simple x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple callbacks: {} components: schemas: GoalListResponse: additionalProperties: false properties: data: items: $ref: '#/components/schemas/Goal' type: array required: - data title: GoalListResponse type: object ErrorResponse: additionalProperties: false properties: errors: items: $ref: '#/components/schemas/Error' minItems: 1 type: array required: - errors title: ErrorResponse type: object Goal: additionalProperties: false properties: created_at: description: UTC timestamp in ISO 8601 format: date-time type: string currency_code: description: ISO 4217 code. Goals are always in BRL. example: BRL type: string current_amount: description: >- The amount saved so far (initial amount plus contributions and allocations), as a decimal string example: '2500.5' format: decimal type: string id: format: uuid type: string kind: description: >- `emergency_fund` is the reserve of the space; every other goal is `generic` enum: - generic - emergency_fund type: string name: type: string progress_percent: description: >- The progress shown in the app, rounded down and capped between 0 and 100 maximum: 100 minimum: 0 type: integer status: enum: - active - completed - archived type: string target_amount: description: The amount the goal aims to reach, as a decimal string example: '10000' format: decimal type: string target_date: description: >- The deadline as `YYYY-MM-DD`; null when the goal has none (the emergency fund never has one) format: date nullable: true type: string required: - id - name - kind - status - target_amount - current_amount - currency_code - progress_percent - target_date - created_at title: Goal type: object Error: additionalProperties: false properties: code: description: Stable machine-readable code example: INVALID_TOKEN type: string details: additionalProperties: true description: Code-specific context type: object message: description: English text for developers type: string request_id: description: The x-request-id response header of the request nullable: true type: string required: - code - message - details - request_id title: Error type: object securitySchemes: personal_api_token: bearerFormat: visor_pat__ description: Personal API token created in Visor Settings scheme: bearer type: http visor_cli_oauth: description: >- OAuth 2.0 access token of the Visor CLI browser login (authorization code with PKCE). Only the first-party Visor CLI client can use it on this API. flows: authorizationCode: authorizationUrl: https://dashboard.visorfinance.app/oauth/authorize refreshUrl: https://dashboard.visorfinance.app/oauth/token scopes: pfm:read: Read financial data pfm:transactions:write: Create, edit, and delete transactions pix:payments:write: Start Pix payments that you confirm with biometrics at your bank tokenUrl: https://dashboard.visorfinance.app/oauth/token type: oauth2 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.