Shares
get_share
readGet share
Check one share link before reporting on it or removing it with delete_share.
Overview
Reads one share link a shopper made for a design from a connected Store customiser: its id, its customiser id and name, the customiser product image and its creation date. The link token and the stored design are not returned. It requires the shares:read scope and has no side effects.
Permission
Requires theshares:readpermission. A connection without it answersinsufficient_scopenaming the permission to approve.
Annotations
Prerequisites
- A share id from list_shares.
- A merchant has connected this store and approved the shares:read scope.
Arguments
The share id, from list_shares.
Result
The share: its id, customiser id and name, image URL and creation date.
The share link.
The product image of the customiser, as the merchant admin shows it. Null when the customiser has none.
When the shopper made the link, UTC. Null on links older than the record.
Error cases
The connection was approved without shares:read.
No share with that id belongs to this store, or it was deleted. Call list_shares to find a valid id.
Read one share
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_share",
"arguments": {
"share_id": 512
}
}
}{
"jsonrpc": "2.0",
"id": 1,
"result": {
"structuredContent": {
"request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
"store": {
"id": 12,
"name": "Demo Signs"
},
"share": {
"id": 512,
"customiser_id": 42,
"customiser_name": "Neon signs",
"image_url": "https://cdn.example.com/customisers/42/product.png",
"created_at": "2026-07-18T03:14:15Z"
}
}
}
}A share of another store (error)
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_share",
"arguments": {
"share_id": 999
}
}
}{
"jsonrpc": "2.0",
"id": 1,
"result": {
"isError": true,
"structuredContent": {
"error": {
"code": "resource_not_found",
"title": "Resource not found",
"detail": "The requested resource does not exist or does not belong to the authenticated store.",
"recovery": "The identifier does not exist in this store. Use the matching list tool to rediscover a valid id."
}
}
}
}