Get a share link
Platform module
GET/share-links/{id}shareLinks.get
A link that opens one clean version of a file without an account (Section 8.6). Public files may have a link without an expiry; Internal links need an expiry within 90 days; Confidential links need an expiry within 30 days, an access code and the recipient's email, which the watermark on every downloaded page carries; Restricted files never get a link. The token and the access code are returned once by `shareLinks.create` and stored only as hashes, so they never appear here. Anyone who can read the file reads its links. Returns one share link with its `ETag`. A share link the caller may not see returns 404.
- Requires the capability data.export.run.
- OAuth scopes: data.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the share link. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: ShareLink
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the share link. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row. |
| attachment_id | string (uuid) | Yes | Identifier of the file the link shares. |
| attachment_version_id | string (uuid) | null | Yes | Clean version the link opens, set from the file's current version. |
| classification | Classification | Yes | Column classification (Section 8.3).Constraints: one of "Public", "Internal", "Confidential", "Restricted" |
| access_code_required | boolean | Yes | True when the link asks for a 6-digit access code; always true for a Confidential file. |
| recipient_email | string (email) | null | Yes | Who the link is for, lowercased. Required for a Confidential file. |
| note | string | null | Yes | What the link is for.Constraints: length 1 to 200 |
| expires_at | string (date-time) | null | Yes | When the link stops opening: within 90 days, 30 for a Confidential file. Null only for a Public file. |
| failed_attempts | integer | Yes | Wrong access codes entered; the link locks at 5.Constraints: range 0 to any |
| open_count | integer | Yes | Successful opens.Constraints: range 0 to any |
| last_opened_at | string (date-time) | null | Yes | When the link was last opened. |
| revoked_at | string (date-time) | null | Yes | When the link was revoked; it never opens again. |
| revoked_by | string (uuid) | null | Yes | Identifier of the person who revoked the link. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"attachment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"attachment_version_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"classification": "Restricted",
"access_code_required": false,
"recipient_email": "alex.rivera@northwindlive.example",
"note": "Stage plot for the venue",
"expires_at": "2026-10-08T14:30:00Z",
"failed_attempts": 0,
"open_count": 2,
"last_opened_at": "2026-10-08T14:30:00Z",
"revoked_at": "2026-10-08T14:30:00Z",
"revoked_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X GET "$XOS_BASE_URL/share-links/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.shareLinks.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.share_links.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos share-links get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f