# Get a file

> A file's details. Its content is downloaded through the file proxy.

Source: https://docs.stacksync.com/api-reference/files/get_file

`GET https://api.stacksync.com/v1/workspaces/{workspace_id}/files/{file_id}`

- Operation: `get_file`
- Resource: Files
- Access: read-only

## Authentication

- `Authorization: Bearer <key>`: A workspace API key (workspace_…, created by a workspace owner under Workspace settings > Stacksync API) acts with editor rights on that workspace only; a user API key (user_…, created under Profile > Stacksync API) acts as that user in every workspace they belong to. POST, PUT and PATCH requests must send Content-Type: application/json. Every authentication failure answers 403.

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `workspace_id` | integer | Yes | The workspace. List the ones your key can reach with GET /v1/workspaces. |
| `file_id` | string (uuid) | Yes | The file. |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `region` | string (besg \| usnv) | Yes | Region of the file: besg (Europe) or usnv (United States) |

## Returns

### 200 OK

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `file_id` | string | Yes |  |
| `name` | string | Yes |  |
| `mime_type` | string \| null | Yes |  |
| `size_bytes` | integer \| null | Yes |  |
| `tags` | array of string | Yes |  |
| `source` | string \| null | Yes |  |
| `source_ref` | string \| null | Yes | Id of the resource the file belongs to, null when it belongs to none |
| `created_at` | string \| null | Yes |  |
| `region` | string | Yes |  |

## Example request

```bash
curl -X GET "https://api.stacksync.com/v1/workspaces/{workspace_id}/files/{file_id}?region=besg" \
  -H "Authorization: Bearer $STACKSYNC_API_KEY"
```

## Example response (200)

```json
{
  "file_id": "<file_id>",
  "name": "<name>",
  "mime_type": "<mime_type>",
  "size_bytes": 0,
  "tags": [
    "<tags>"
  ],
  "source": "<source>",
  "source_ref": "<source_ref>",
  "created_at": "<created_at>",
  "region": "<region>"
}
```

## Errors

| Status | Meaning | Body |
| --- | --- | --- |
| 400 | Bad Request | `{ "error": string, "msg": string, "field": string \| null }` |
| 403 | Forbidden | `{ "error": string, "msg": string, "field": string \| null }` |
| 404 | Not Found | `{ "error": string, "msg": string, "field": string \| null }` |

## Related

- [API Reference overview](https://docs.stacksync.com/api-reference): base URLs, regions, pagination, idempotency and errors
- [Authentication](https://docs.stacksync.com/api-reference/authentication): API keys and the 403 answers
- OpenAPI document: https://docs.stacksync.com/openapi.json
- [List files](https://docs.stacksync.com/api-reference/files/list_files)