---
updatedAt: 2026-01-28T13:46:01.000Z
---

Fetch the complete documentation index at: https://developer.connecteam.com/llms.txt. Use this file to discover all available pages before exploring further.

# Overview

The Attachments API enables you to securely upload files to Connecteam's cloud storage for use with other platform features like Chat, Scheduler, Users, and Quick Tasks.

## How It Works

File uploads follow a three-step process:

1. **Generate Upload URL** - Get a pre-signed URL for secure uploading
2. **Upload File** - Upload directly to cloud storage using the pre-signed URL
3. **Complete Upload** - Finalize the upload to register the file

> ⚠️ Time Limit
>
> The pre-signed upload URL expires after **300 seconds** (5 minutes). You must complete the upload within this time or generate a new URL.

***

## Available Endpoints

| Method | Endpoint                                       | Description                      |
| :----- | :--------------------------------------------- | :------------------------------- |
| POST   | /attachments/v1/files/generate-upload-url      | Generate a pre-signed upload URL |
| PUT    | /attachments/v1/files/complete-upload/{fileId} | Finalize the upload process      |
| GET    | /attachments/v1/files/{fileId}                 | Get file metadata and status     |

***

## Feature Types

When generating an upload URL, you must specify which feature the attachment is for:

| Feature Type     | Description                             |
| :--------------- | :-------------------------------------- |
| `chat`           | Chat messages and conversations         |
| `shiftscheduler` | Shift scheduler attachments             |
| `users`          | User profile documents (e.g., payslips) |
| `quicktasks`     | Quick task attachments                  |

***

## Constraints

| Constraint            | Value                   |
| :-------------------- | :---------------------- |
| Maximum file size     | 1 GB                    |
| Upload URL expiration | 300 seconds (5 minutes) |
| Supported file types  | Any valid MIME type     |

> 🚨 File Size Limit
>
> Files larger than **1 GB** will be rejected during the complete-upload step and automatically deleted from storage.

***

## Authentication

All endpoints require authentication via API key or OAuth 2.0.

### Required Scopes

| Scope             | Operations                           |
| :---------------- | :----------------------------------- |
| attachments.read  | GET file metadata                    |
| attachments.write | Generate upload URL, complete upload |

***

## What Can You Achieve?

With the Attachments API, you can:

* Securely upload files to the cloud for use with Connecteam's various API features
* Automate file uploads and data retrieval, reducing manual input and errors
* Attach files to chat messages, user profiles, tasks, and scheduler notes

### Important Considerations

* **Data Security**: Ensure file transfers comply with your organization's security policies
* **API Limits**: Be aware of rate limits when planning file operations
* **Testing**: Always test uploads in a development environment first

> 📝 Note
>
> Files uploaded via this API are for use with Connecteam features only, not for general storage purposes.

***

## Guide Pages

| Page                                                 | Description                             |
| :--------------------------------------------------- | :-------------------------------------- |
| [Upload file to the Cloud](upload-file-to-the-cloud) | Step-by-step upload tutorial            |
| [Code snippets examples](code-snippets-examples)     | Ready-to-use code in multiple languages |

***

[API Reference](https://developer.connecteam.com/reference/)