List published entries

get

https://api.andesine.app/content/entries

Returns a flat page of entries from a publication snapshot. The default channel is published. On later pages, pass the returned snapshotID and pagination.nextCursor, and omit channel. Select direct children using collectionID, collectionPath, or collectionSlugPath, or include nested entries with descendants: true. descendants requires a collection scope. All property filters must match the assigned version. includeContent: true returns validated full content, properties, fragments, assets, and recorded schema metadata. An invalid full item fails the page. Keep the same scope and filters across pages. Results are ordered by ID, not display order.

Required API key permissions: read:publishing. Write permissions also grant read access for the same resource.

Authentication

apiKeyhttp, bearer, Andesine API key

Use an Andesine API key as a Bearer token

oauthhttp, bearer, Andesine OAuth access token

Use an OAuth access token with andesine:api scope. Send x-workspace-id for workspace operations. Current user permissions apply.

Query parameters

cursorstring

Cursor from the previous page; keep the same filters

limitnumber

Default: 50

collectionIDstring

collectionPathstring

Decoded content path, such as /Docs/Page or coll_ID/Page. Names are case-sensitive. Do not URL-encode names before passing them to the SDK.

collectionSlugPathstring

Decoded derived slug path, such as /docs/getting-started or coll_ID/getting-started. Use the returned slugPath without URL encoding.

channelPublishingChannelCode

snapshotIDstring

descendantsboolean

Default: false

includeContentboolean

Default: false

filtersarray of PropertyFilter

Default: []

Options

Any of

TextPropertyFilterobject

kind*constant

Value: "text"

key*string

Property identifier

operatorstring

One of: "any", "all", "none"Default: "any"

values*array of string

NumberPropertyFilterobject

kind*constant

Value: "number"

key*string

Property identifier

operator*ComparisonOperator

One of: "equals", "notEquals", "greaterThan", "greaterThanOrEqual", "lessThan", "lessThanOrEqual"

value*number

BooleanPropertyFilterobject

kind*constant

Value: "boolean"

key*string

Property identifier

value*boolean

DatePropertyFilterobject

kind*constant

Value: "date"

key*string

Property identifier

operator*ComparisonOperator

One of: "equals", "notEquals", "greaterThan", "greaterThanOrEqual", "lessThan", "lessThanOrEqual"

value*string

Headers

x-workspace-idstring

Required for OAuth: ID of the workspace to access. API keys use their own workspace.

Responses

200OKapplication/json

Bodyobject

5 fields

channel*PublishingChannelCode

snapshotID*string

expiresAt*any of

Options

Any of

Option 1string (date-time)

Option 2null

pagination*Pagination

2 fields

nextCursor*any of

Options

Any of

Option 1string

Option 2null

hasMore*boolean

data*any of

Options

Any of

Option 1array of PublishedEntryContent

id*string

path*string

slugPath*string

collectionID*any of

Options

Any of

Option 1string

Option 2null

schema*any of

Options

Any of

ContentSchemaMetadataobject

revisionID*string

Recorded effective schema revision

hash*string

Hash of the effective schema definition

Option 2null

name*string

Entry name stored in the published version

version*EntryVersionSummary

10 fields

id*string

ID of the version

entryID*string

ID of the versioned entry

entryName*string

Entry name stored in the version

hash*string

Hash of the version content

name*any of

Optional name of the version

Options

Any of

Option 1string

Option 2null

reason*string

Reason why the version was created

One of: "auto", "manual", "revert", "schema-migration", "import"

sourceVersionID*any of

Source version used for a revert

Options

Any of

Option 1string

Option 2null

contributorIDs*array of string

Memberships that contributed to the version

createdAt*string

Time when the version was created

updatedAt*string

Time when the version name was last updated

assets*array of PublishedAsset

7 fields

assetID*string

variant*AssetVariant

One of: "thumbnail", "display", "source"

format*AssetFileFormat

One of: "jpeg", "png", "webp"

width*number

height*number

byteSize*number

url*string

content*ContentNode

5 fields

type*string

attrsobject

1 field

{key}any

contentarray of ContentNode

Repeats ContentNode

marksarray of ContentMark

2 fields

type*string

attrsobject

1 field

{key}any

textstring

mdxstring

Content as MDX: the title as H1, properties as elements in place, fragments as elements, and images as asset:; frontmatter properties are also read, and entries.update and versions.create import image URLs

fragments*object

1 field

{key}EntryFragment

2 fields

name*string

Source fragment name

content*ContentNode

5 fields

type*string

attrsobject

1 field

{key}any

contentarray of ContentNode

Repeats ContentNode

marksarray of ContentMark

2 fields

type*string

attrsobject

1 field

{key}any

textstring

properties*object

1 field

{key}EntryProperty

3 fields

name*string

Source property name

type*string

Property type

One of: "text", "number", "checkbox", "date", "url", "select", "multi-select"

value*EntryPropertyValue

Options

Any of

Option 1string

Option 2number

Option 3boolean

Option 4array of string

Option 5null

Option 2array of PublishedEntrySummary

path*string

slugPath*string

id*string

ID of the published entry

name*string

Entry name stored in the published version

version*PublishedVersion

2 fields

id*string

ID of the assigned version

hash*string

Hash of the assigned version content

collectionID*any of

Options

Any of

Option 1string

Option 2null

400Bad Requestapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "BAD_REQUEST"

status*constant

Value: 400

message*string

Default: "Bad Request"

dataValidationErrorData

2 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

issuesarray of ValidationIssue

3 fields

message*string

codestring

patharray of any of

Options

Any of

Option 1string

Option 2number

Option 3object

key*any of

Options

Any of

Option 1string

Option 2number

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

401Unauthorizedapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "UNAUTHORIZED"

status*constant

Value: 401

message*string

Default: "Unauthorized"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

403Forbiddenapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "FORBIDDEN"

status*constant

Value: 403

message*string

Default: "Forbidden"

dataForbiddenErrorData

4 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

missingPermissionsarray of string

requiredPlanconstant

Value: "pro"

actionstring

The requested action that was denied

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

404Not Foundapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "NOT_FOUND"

status*constant

Value: 404

message*string

Default: "Not Found"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

409Conflictapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "CONFLICT"

status*constant

Value: 409

message*string

Default: "Conflict"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

429Too Many Requestsapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "TOO_MANY_REQUESTS"

status*constant

Value: 429

message*string

Default: "Too Many Requests"

dataRateLimitErrorData

3 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

limitstring

The limit that was reached: a short-term rate limit, or a monthly API call, AI credit, or spending limit

One of: "rate", "api-calls", "ai-credits", "spending"

retryAfterSecondsnumber

Minimum delay before another attempt, in seconds. Also sent in Retry-After.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

500Internal Server Errorapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "INTERNAL_SERVER_ERROR"

status*constant

Value: 500

message*string

Default: "Internal Server Error"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: true

code*constant

Value: "CONTENT_SCHEMA_INVALID"

status*constant

Value: 500

message*string

Default: "CONTENT_SCHEMA_INVALID"

data*ContentSchemaInvalidErrorData

5 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

entryIDstring

versionIDstring

revisionID*any of

Options

Any of

Option 1string

Option 2null

issues*array of ContentSchemaIssue

4 fields

code*string

One of: "invalid_schema", "invalid_structure", "missing_field", "unknown_field", "duplicate_field", "field_kind_mismatch", "field_key_mismatch", "property_type_mismatch", "invalid_property_value", "invalid_field_options", "invalid_allowed_blocks", "invalid_fragment_content"

message*string

path*array of any of

Options

Any of

Option 1string

Option 2number

fieldIDstring

Option 3object

defined*constant

Value: false

code*string

status*number

message*string

dataany

503Service Unavailableapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "SERVICE_UNAVAILABLE"

status*constant

Value: 503

message*string

Default: "Service Unavailable"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

Request

bash

curl --request GET \
  --url 'https://api.andesine.app/content/entries?limit=20&channel=published' \
  --header 'Authorization: Bearer <token>'

javascript

const response = await fetch("https://api.andesine.app/content/entries?limit=20&channel=published", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();

python

import requests

response = requests.get(
    "https://api.andesine.app/content/entries?limit=20&channel=published",
    headers={
        "Authorization": "Bearer <token>",
    },
)

print(response.json())

typescript

import { createClient } from "@andesine/sdk";

const client = createClient({ apiKey: process.env.ANDESINE_API_KEY });

await client.content.listEntries({
  channel: "published",
  limit: 20
});

Response

json

{
  "channel": "string",
  "snapshotID": "string",
  "expiresAt": "2026-01-01T00:00:00Z",
  "pagination": {
    "nextCursor": "string",
    "hasMore": true
  },
  "data": [
    {
      "id": "string",
      "path": "string",
      "slugPath": "string",
      "collectionID": "string",
      "schema": {
        "revisionID": "string",
        "hash": "string"
      },
      "name": "string",
      "version": {
        "id": "string",
        "entryID": "string",
        "entryName": "string",
        "hash": "string",
        "name": "string",
        "reason": "auto",
        "sourceVersionID": "string",
        "contributorIDs": [
          "string"
        ],
        "createdAt": "string",
        "updatedAt": "string"
      },
      "assets": [
        {
          "assetID": "string",
          "variant": "thumbnail",
          "format": "jpeg",
          "width": 0,
          "height": 0,
          "byteSize": 0,
          "url": "string"
        }
      ],
      "content": {
        "type": "string",
        "attrs": {},
        "content": [],
        "marks": [
          {
            "type": "string",
            "attrs": {}
          }
        ],
        "text": "string"
      },
      "mdx": "string",
      "fragments": {},
      "properties": {}
    }
  ]
}

json

{
  "defined": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "Bad Request",
  "data": {
    "hints": [
      "string"
    ],
    "issues": [
      {
        "message": "string",
        "code": "string",
        "path": [
          "string"
        ]
      }
    ]
  }
}

json

{
  "defined": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "Unauthorized",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "Forbidden",
  "data": {
    "hints": [
      "string"
    ],
    "missingPermissions": [
      "string"
    ],
    "requiredPlan": "pro",
    "action": "string"
  }
}

json

{
  "defined": true,
  "code": "NOT_FOUND",
  "status": 404,
  "message": "Not Found",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "CONFLICT",
  "status": 409,
  "message": "Conflict",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "TOO_MANY_REQUESTS",
  "status": 429,
  "message": "Too Many Requests",
  "data": {
    "hints": [
      "string"
    ],
    "limit": "rate",
    "retryAfterSeconds": 0
  }
}

json

{
  "defined": true,
  "code": "INTERNAL_SERVER_ERROR",
  "status": 500,
  "message": "Internal Server Error",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "SERVICE_UNAVAILABLE",
  "status": 503,
  "message": "Service Unavailable",
  "data": {
    "hints": [
      "string"
    ]
  }
}