> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Blob List Shares

> List the active share links of your account with GET /v1/shares, with expiry, remaining downloads and password status.

<ParamField header="Authorization" type="string" placeholder="API Key" required>
  The API key for your account. You can find this in your [account settings](https://squarecloud.app/en/account/security).
</ParamField>

List Shares returns every share link of the account that hasn't expired or been revoked, with how many downloads each has left. Requires the `blob:read` scope. A link whose file was deleted, moved or changed visibility leaves the list the first time someone opens it.

### Rate limits

<Note>20 requests per minute (`RATE_LIMITED`, 429).</Note>

### Response

<ResponseField name="status" type="string">
  "success" if successful, "error" if not.
</ResponseField>

<ResponseField name="response" type="object">
  <Expandable title="Toggle object">
    <ResponseField name="shares" type="array">
      <Expandable title="Toggle object">
        <ResponseField name="id" type="string">
          The share id.
        </ResponseField>

        <ResponseField name="url" type="string">
          The link.
        </ResponseField>

        <ResponseField name="object" type="string">
          The id of the shared file.
        </ResponseField>

        <ResponseField name="expires_at" type="ISO 8601">
          When the link expires.
        </ResponseField>

        <ResponseField name="remaining_downloads" type="number | null">
          Downloads left, or `null` when there is no cap.
        </ResponseField>

        <ResponseField name="password" type="boolean">
          Whether the link asks for a password.
        </ResponseField>

        <ResponseField name="created_at" type="ISO 8601">
          When the link was created.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://blob.squarecloud.app/v1/shares' \
    --header 'Authorization: YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "status": "success",
    "response": {
      "shares": [
        {
          "id": "q8Zr2LwX7nT0vKc4Hs1YbA",
          "url": "https://files.squarecloud.dev/s/q8Zr2LwX7nT0vKc4Hs1YbA",
          "object": "prv/3155597145698959364/reports/q3_mugws5c0-9f86d081884c7d659a2feaa0c55ad015.pdf",
          "expires_at": "2026-10-02T12:00:00.000Z",
          "remaining_downloads": 3,
          "password": false,
          "created_at": "2026-09-25T12:00:00.000Z"
        }
      ]
    }
  }
  ```
</ResponseExample>

### Errors

| Code           | HTTP | When                               |
| -------------- | ---- | ---------------------------------- |
| `RATE_LIMITED` | 429  | More than 20 requests in a minute. |