Needs the read scope.
Call
- Tool:
get_entry - Scope:
read - Reads only.
- Acts on a store.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
product |
object |
Yes | |
entry |
object |
Yes | |
preview |
string |
No | A token a seller made for the entry’s product’s page, which opens a published entry of the product unpublished, gated as ever, or for the entry itself, which opens it unpublished too as its staged body shows it; with it, any entry it does not open is not_found preview. |
include |
array of "body" |
No | What else the read answers: body reads the body whole, as readBody does, and fails the read where readBody would. |
{
"type": "object",
"properties": {
"product": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"slug"
],
"additionalProperties": false
}
]
},
"entry": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"product": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"slug"
],
"additionalProperties": false
}
]
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"product",
"slug"
],
"additionalProperties": false
}
]
},
"preview": {
"description": "A token a seller made for the entry's product's page, which opens a published entry of the product unpublished, gated as ever, or for the entry itself, which opens it unpublished too as its staged body shows it; with it, any entry it does not open is `not_found` `preview`.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"include": {
"description": "What else the read answers: `body` reads the body whole, as `readBody` does, and fails the read where `readBody` would.",
"type": "array",
"items": {
"type": "string",
"const": "body"
},
"maxItems": 1
}
},
"required": [
"product",
"entry"
],
"additionalProperties": false
}Answer
| Name | Type | Required | Description |
|---|---|---|---|
files |
object |
Yes | |
maps |
array of object |
Yes | The maps the body’s map blocks show, matched to a block by latitude and longitude; none while the body is kept from the reader. |
quiz |
object or null |
Yes | |
body |
object or null |
Yes | |
attachments |
array of object |
Yes | |
access |
string |
Yes | |
requires |
object |
Yes | |
opens_at |
string or null |
Yes | When its content opens to everyone it admits; null once open or without a release, and for a broken one, which stays locked. |
completed_at |
string or null |
Yes | |
duration |
number or null |
Yes | The measured length in seconds of a podcast episode’s own audio, told even when it is locked; null without one. |
previewed |
boolean |
Yes | Whether the read’s preview token is the entry’s own, which shows its staged body past its gate. |
product |
object |
Yes | |
id |
string |
Yes | |
product_id |
string |
Yes | |
slug |
string |
Yes | |
path |
string |
Yes | The storefront path. |
url |
string or null |
Yes | The absolute URL on the store’s verified hostname, or null before it has one. |
title |
string |
Yes | |
subtitle |
string or null |
Yes | |
section |
string or null |
Yes | |
author |
object or null |
Yes | Who signs it, or null when unsigned; a member with no name, or one central no longer holds, answers a null name. |
tags |
array of string |
Yes | |
preview |
string or null |
Yes | The teaser, in the rich text format as stored. |
position |
number |
Yes | |
published_at |
string or null |
Yes | |
unlisted_at |
string or null |
Yes | Set while it is out of the product’s lists and indexes, though still reachable. |
created_at |
string or null |
Yes | |
updated_at |
string or null |
Yes | |
settings |
object |
Yes |
The answer’s full shape is on its API reference page.