# Read a share link

Source: https://docs.vlayers.ai/reference/share-links/get-share-link

`GET /v1/share-links/{linkId}` · scope `share_links:read`

Reads one share link with its recent refusals and stops: why a visit was turned away or a conversation ended (`expired`, `revoked`, `conversations_used`, `minutes_used`, `budget_used`, `busy` and the others), each with when and how many times in a row. Use it to see why a link stopped working, and send its `version` as `If-Match` when you change it.

Requires an API key with the `share_links:read` scope.

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `linkId` | path | string | yes | The share link id, from the list or from the answer that made it. Example: `"grt_0192f5e1a2b37c4d8e5f6a7b8c9d0e1f"` |

## Request

cURL:

```bash
curl "https://api.vlayers.ai/v1/share-links/$SHARE_LINK_ID" \
  -H "Authorization: Bearer $VOICELAYER_API_KEY"
```

TypeScript:

```ts
import { VoiceLayer } from '@voicelayer/api';

const voicelayer = new VoiceLayer();

const { state } = await voicelayer.shareLinks.getShareLink('<share-link-id>');
console.log(state);
```

Python:

```python
from voicelayer import VoiceLayer

vl = VoiceLayer()

result = vl.shareLinks.get_share_link("<share-link-id>")
print(result.state)
```

## Response `200`

```json
{
  "id": "grt_0192f5e1a2b37c4d8e5f6a7b8c9d0e1f",
  "agentId": "0192f5c2-6f7a-7b9c-8d1e-2f3a4b5c6d78",
  "state": "active",
  "title": "Books team test",
  "displayName": "Acme Books",
  "target": "live",
  "sealedVersionLabel": "Published version of Nov 8",
  "sealedAt": "2026-11-08T15:12:00.000Z",
  "privacyUrl": "https://acmebooks.example/privacy",
  "limits": {
    "conversations": 20,
    "voiceMinutes": 60,
    "dollarsMicros": 10000000,
    "atOnce": 2,
    "callMinutes": 5,
    "typedMessages": 40,
    "typedDollarsMicros": 1000000,
    "perAddressPerDay": 5,
    "perAddressPerHour": 3
  },
  "expiresAt": "2026-11-15T15:12:00.000Z",
  "tools": {
    "off": [
      "refund_order",
      "vl_send_text"
    ]
  },
  "usage": {
    "conversations": 3,
    "minutes": 12.5,
    "spentMicros": 1500000
  },
  "lastUsedAt": "2026-11-09T09:30:00.000Z",
  "revokedBy": null,
  "revokedAt": null,
  "createdBy": "user_2abc",
  "createdAt": "2026-11-08T15:12:00.000Z",
  "updatedAt": "2026-11-08T15:12:00.000Z",
  "version": 3,
  "recent": [
    {
      "reason": "busy",
      "at": "2026-11-09T09:31:00.000Z",
      "count": 2
    }
  ]
}
```
