---
title: "Get Platform File Url By Id Next"
method: GET
path: "/api/v2/retool/platform-files/get-platform-file-url-next"
tags: ["v2", "Platform Files"]
---

# Get Platform File Url By Id Next

`GET /api/v2/retool/platform-files/get-platform-file-url-next`

## Request

- Base URL: `https://api.caresquare.com.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.caresquare.com.au/api/v2/retool/platform-files/get-platform-file-url-next`
- Auth: none declared

Returns the direct file url for the platform file id provided.
Supports both public and private files (generates presigned URL for private files).

Used by caresquare-next for document download/view in the participant documents tab.

Query params:
    - file_id: UUID of the platform file (platform_files.id)
    - requestor_plan_manager_id: UUID of the requesting plan manager (for access control)
    - requestor_user_id: Optional user ID for access control

## Response `200`

Successful Response

- ApiResponseJSON: Standardised JSON Api Response To conforms to Aus Gov recommended format [api.gov.au](https://api.gov.au/sections/api-response.html#response-payload) Which is a modification of [JSON:API]( https://jsonapi.org/format/#introduction) data meta: meta object that contains non-standard meta-information messages: container for informational and warning messages related to the transaction. Not Implemented (not currently required): Links: [HATEOS Links](https://api.gov.au/sections/api-response.html#response-payload)
  - `data` unknown[]: List of items returned in the response following given criteria
    - unknown
  - `meta` ApiResponseMeta: Standardised Api Response Meta Not always required (except for example; with paginated results) Future: Could provide base that includes org information, copy-write etc
    - `processing_time_ms` integer, nullable
    - `total_records` integer, nullable
    - `page` integer, nullable
    - `limit` integer, nullable
    - `count` integer, nullable
    - `cursor` unknown
    - `cursor_last` unknown
    - `more_data_available` boolean, nullable
  - `messages` ApiResponseMessage[], nullable: Response Messages
    - `message_type` 'debug' | 'info' | 'warning' | 'error', required
    - `message` string, required

---

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