Skip to content
Docs
Select language:English

/api/v1/share-links/{id}/preview

GET
/api/v1/share-links/{id}/preview
curl --request GET \
  --url https://example.com/api/v1/share-links/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/preview

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Query Parameters

Section titled “Query Parameters”
page
integer
<= 100

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
scope
required
string
Allowed values: thing place view
title
required
string | null
thing
required
Any of:
object
name
required
string | null
type
required
Any of:
object
icon
required
string | null
name
required
string | null
builtinKey
required
string | null
path
required
Array<object>
object
name
required
string | null
kind
required
string
Allowed values: place container
isUnplaced
required
boolean
quantity
required
number
condition
required
Any of:
string
Allowed values: new good fair poor broken
description
required
string | null
photo
required
Any of:
object
thumbUrl
required
string | null
url
required
string
place
required
Any of:
object
name
required
string
isUnplaced
required
boolean
path
required
Array<object>
object
name
required
string | null
kind
required
string
Allowed values: place container
isUnplaced
required
boolean
total
required
integer
>= -9007199254740991 <= 9007199254740991
cap
required
integer
>= -9007199254740991 <= 9007199254740991
page
required
integer
>= -9007199254740991 <= 9007199254740991
nextPage
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
items
required
Array<object>
object
name
required
string | null
type
required
Any of:
object
icon
required
string | null
name
required
string | null
builtinKey
required
string | null
path
required
Array<object>
object
name
required
string | null
kind
required
string
Allowed values: place container
isUnplaced
required
boolean
quantity
required
number
condition
required
Any of:
string
Allowed values: new good fair poor broken
description
required
string | null
photo
required
Any of:
object
thumbUrl
required
string | null
url
required
string
expiresAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
Example
{
  "scope": "thing",
  "thing": {
    "path": [
      {
        "kind": "place"
      }
    ],
    "condition": "new"
  },
  "place": {
    "path": [
      {
        "kind": "place"
      }
    ]
  },
  "items": [
    {
      "path": [
        {
          "kind": "place"
        }
      ],
      "condition": "new"
    }
  ]
}