Skip to content
scrapeatlas.Dashboard

Get a Substack Note

Try in Playground

Retrieve a public Note’s text, rich-text document, author details, reactions, restacks, attachments and parent discussion context.

GET/v1/substack/notex-api-key
x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters
1
idstringrequiredquery

Required positive numeric Note ID, 1–15 digits.

Example601
Response fields
593
requestIdstring

Request correlation UUID.

Source request attempts, decoded bytes and elapsed milliseconds.

accounting.upstreamRequestsinteger

Number of upstream request attempts.

≥ 0

accounting.responseBytesinteger

Decoded source bytes read during this request.

≥ 0

accounting.durationMsnumber

Elapsed request time in milliseconds.

≥ 0

successboolean

True when usable data is returned; inspect status and coverage.

statusenum

success or partial for usable data; failed or challenged for a failure response.

one of: success, partial

sourceUrlstring

Canonical public URL for the requested publication, post or writer.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

Result coverage and extraction warnings.

coverage.sourcestring

Public Substack web data.

coverage.completeboolean

Whether the returned result has no reported omissions.

coverage.warningsstring[]

Warnings that explain partial results or missing fields.

coverage.orderenumoptional

Reported result order: source_order or ranked.

one of: source_order, ranked

Note feed record with content and discussion context.

item.typeenum

post for a newsletter post or comment for a Note.

one of: post, comment

item.entity_keystringnullable

Substack feed entity key.

Post metadata for post entries.

item.post.idinteger

Numeric post ID.

0 – 9007199254740991

item.post.publication_idinteger

Owning publication’s numeric ID.

0 – 9007199254740991

item.post.slugstring

Post URL slug.

item.post.titlestring

Post title.

item.post.subtitlestringnullable

Post subtitle.

item.post.typestringnullable

Post type as reported by Substack.

item.post.audiencestringnullable

Post audience label.

item.post.canonical_urlstringnullable

Canonical post URL.

item.post.post_datestringnullable

Publication timestamp.

item.post.updated_atstringnullable

Post update timestamp.

item.post.descriptionstringnullable

Post summary.

item.post.body_htmlstringnullable

Published article HTML.

item.post.truncated_body_textstringnullable

Published plain-text excerpt.

item.post.cover_imagestringnullable

Post cover image URL.

item.post.wordcountintegernullable

Source-reported article word count.

item.post.languagestringnullable

Post language code.

item.post.reaction_countintegernullable

Post reaction count.

item.post.reactionsobject

Reaction counts keyed by reaction type.

item.post.restacksintegernullable

Post restack count.

item.post.comment_countintegernullable

Post comment count.

item.post.child_comment_countintegernullable

Nested comment count reported for the post.

item.post.podcast_urlstringnullable

Published podcast audio URL.

item.post.podcast_durationnumbernullable

Source-reported podcast duration.

item.post.podcast_art_urlstringnullable

Podcast artwork URL.

item.post.video_upload_idstringnullable

Published video upload identifier.

item.post.podcast_upload_idstringnullable

Published podcast upload identifier.

item.post.voiceover_upload_idstringnullable

Published voiceover upload identifier.

item.post.write_comment_permissionsstringnullable

Published comment-permission label.

item.post.section_idintegernullable

Publication section ID.

item.post.section_namestringnullable

Publication section name.

item.post.section_slugstringnullable

Publication section slug.

item.post.previous_post_slugstringnullable

Previous post slug when published.

item.post.next_post_slugstringnullable

Next post slug when published.

item.post.is_geoblockedbooleannullable

Published geoblocking flag.

item.post.is_publishedbooleannullable

Published-state flag.

Public author bylines.

up to 100 items

item.post.publishedBylines.idinteger

Numeric author ID.

0 – 9007199254740991

item.post.publishedBylines.namestringnullable

Public author name.

item.post.publishedBylines.handlestringnullable

Public author handle.

item.post.publishedBylines.photo_urlstringnullable

Author profile image URL.

item.post.publishedBylines.biostringnullable

Public author biography.

item.post.publishedBylines.twitter_screen_namestringnullable

Published X username.

item.post.publishedBylines.is_guestbooleannullable

Whether the byline is a guest author.

item.post.publishedBylines.bestseller_tierintegernullable

Author bestseller tier.

Post tags.

up to 100 items

item.post.postTags.idstring | integernullable

Source tag identifier, a string or number.

item.post.postTags.namestringnullable

Tag name.

item.post.postTags.slugstringnullable

Tag URL slug.

Published audio and video metadata.

up to 100 items

item.post.media.typeenum

Media type: video, podcast, podcast_preview, voiceover or audio.

one of: video, podcast, podcast_preview, voiceover, audio

item.post.media.urlstringnullable

Published media URL.

item.post.media.durationnumbernullable

Source-reported media duration.

item.post.media.thumbnailstringnullable

Published preview image URL.

item.post.media.uploadIdstringnullable

Published media upload identifier.

item.post.media.namestringnullable

Published media name.

item.post.media.media_typestringnullable

Source-reported media type.

item.post.media.statestringnullable

Published media processing state.

item.post.media.created_atstringnullable

Media creation timestamp.

item.post.media.uploaded_atstringnullable

Media upload timestamp.

item.post.media.widthintegernullable

Media width in pixels.

item.post.media.heightintegernullable

Media height in pixels.

item.post.media.thumbnail_idintegernullable

Source thumbnail identifier.

item.post.media.is_muxbooleannullable

Whether the source marks this as streaming media.

item.post.media.mux_playback_idstringnullable

Published streaming playback identifier.

item.post.media.mux_preview_playback_idstringnullable

Published streaming preview playback identifier.

item.post.media.extractedAudioUploadIdstringnullable

Published extracted-audio upload identifier.

Published transcript and caption link metadata.

item.post.media.transcription.transcript_urlstringnullable

Published transcript URL.

item.post.media.transcription.cdn_urlstringnullable

Published transcript CDN URL.

item.post.media.transcription.cdn_unaligned_urlstringnullable

Published unaligned transcript URL.

item.post.media.transcription.signed_captionsobject[]

Published caption tracks and temporary access URLs.

up to 100 items

Note metadata for comment entries.

item.comment.idinteger

Numeric comment ID.

0 – 9007199254740991

item.comment.bodystringnullable

Published comment text.

item.comment.body_jsonobjectnullable

Published rich-text document with formatting and links.

item.comment.publication_idintegernullable

Publication ID.

item.comment.post_idintegernullable

Post ID.

item.comment.user_idintegernullable

Comment author’s numeric user ID.

item.comment.ancestor_pathstringnullable

Source-reported ancestor path.

item.comment.typestringnullable

Comment type reported by Substack.

item.comment.deletedbooleannullable

Published deletion flag.

item.comment.datestringnullable

Comment publication timestamp.

item.comment.edited_atstringnullable

Comment edit timestamp.

item.comment.namestringnullable

Public commenter name.

item.comment.photo_urlstringnullable

Commenter image URL.

item.comment.handlestringnullable

Public commenter handle.

item.comment.user_slugstringnullable

Public commenter profile slug.

item.comment.reaction_countintegernullable

Comment reaction count.

item.comment.reactionsobject

Reaction counts keyed by reaction type.

item.comment.restacksintegernullable

Comment restack count.

item.comment.children_countintegernullable

Source-reported reply count.

item.comment.parentIdintegernullable

Parent comment ID, or null for a top-level comment.

item.comment.depthinteger

Reply depth; top-level comments have depth zero.

≥ 0

item.comment.biostringnullable

Public Note author biography.

item.comment.languagestringnullable

Note language code.

item.comment.user_bestseller_tierintegernullable

Note author bestseller tier.

Note author’s primary publication.

item.comment.user_primary_publication.idinteger

Numeric publication ID.

0 – 9007199254740991

item.comment.user_primary_publication.namestring

Publication name.

item.comment.user_primary_publication.subdomainstring

Substack publication subdomain.

item.comment.user_primary_publication.custom_domainstringnullable

Published custom-domain name, or null.

item.comment.user_primary_publication.author_idintegernullable

Publication owner’s numeric user ID.

item.comment.user_primary_publication.author_namestringnullable

Publication owner’s public name.

item.comment.user_primary_publication.author_handlestringnullable

Publication owner’s public handle.

item.comment.user_primary_publication.author_photo_urlstringnullable

Public author profile image URL.

item.comment.user_primary_publication.author_biostringnullable

Public author biography.

item.comment.user_primary_publication.twitter_screen_namestringnullable

Published X username.

item.comment.user_primary_publication.descriptionstringnullable

Publication description.

item.comment.user_primary_publication.hero_textstringnullable

Publication introduction text.

item.comment.user_primary_publication.logo_urlstringnullable

Publication logo URL.

item.comment.user_primary_publication.logo_url_widestringnullable

Wide publication logo URL.

item.comment.user_primary_publication.cover_photo_urlstringnullable

Publication cover image URL.

item.comment.user_primary_publication.created_atstringnullable

Publication creation timestamp.

item.comment.user_primary_publication.languagestringnullable

Publication language code.

item.comment.user_primary_publication.copyrightstringnullable

Published copyright attribution.

item.comment.user_primary_publication.typestringnullable

Publication type as reported by Substack.

item.comment.user_primary_publication.has_postsbooleannullable

Whether the publication reports posts.

item.comment.user_primary_publication.has_podcastbooleannullable

Whether the publication reports a podcast.

item.comment.user_primary_publication.has_recommendationsbooleannullable

Whether the publication reports recommendations.

item.comment.user_primary_publication.podcast_titlestringnullable

Published podcast title.

item.comment.user_primary_publication.podcast_descriptionstringnullable

Published podcast description.

item.comment.user_primary_publication.podcast_feed_urlstringnullable

Published podcast feed URL.

item.comment.user_primary_publication.podcast_art_urlstringnullable

Podcast artwork URL.

item.comment.user_primary_publication.freeSubscriberCountstringnullable

Displayed free-subscriber count text.

item.comment.user_primary_publication.rankingDetailstringnullable

Published subscriber-ranking description.

item.comment.user_primary_publication.author_bestseller_tierintegernullable

Author bestseller tier.

Publication sections in source order.

up to 100 items

item.comment.user_primary_publication.sections.idinteger

Numeric section ID.

0 – 9007199254740991

item.comment.user_primary_publication.sections.namestringnullable

Section name.

item.comment.user_primary_publication.sections.slugstringnullable

Section URL slug.

item.comment.user_primary_publication.sections.descriptionstringnullable

Section description.

item.comment.user_primary_publication.sections.is_podcastbooleannullable

Whether this section is a podcast.

Published Note attachments.

up to 100 items

item.comment.attachments.idstring | integernullable

Source attachment identifier, a string or number.

item.comment.attachments.typestringnullable

Attachment type reported by Substack.

item.comment.attachments.urlstringnullable

Published attachment URL.

item.comment.attachments.thumbnailstringnullable

Attachment preview image URL.

Publication recommended in this attachment.

item.comment.attachments.recommendedPublication.idinteger

Numeric publication ID.

0 – 9007199254740991

item.comment.attachments.recommendedPublication.namestring

Publication name.

item.comment.attachments.recommendedPublication.subdomainstring

Substack publication subdomain.

item.comment.attachments.recommendedPublication.custom_domainstringnullable

Published custom-domain name, or null.

item.comment.attachments.recommendedPublication.author_idintegernullable

Publication owner’s numeric user ID.

item.comment.attachments.recommendedPublication.author_namestringnullable

Publication owner’s public name.

item.comment.attachments.recommendedPublication.author_handlestringnullable

Publication owner’s public handle.

item.comment.attachments.recommendedPublication.author_photo_urlstringnullable

Public author profile image URL.

item.comment.attachments.recommendedPublication.author_biostringnullable

Public author biography.

item.comment.attachments.recommendedPublication.twitter_screen_namestringnullable

Published X username.

item.comment.attachments.recommendedPublication.descriptionstringnullable

Publication description.

item.comment.attachments.recommendedPublication.hero_textstringnullable

Publication introduction text.

item.comment.attachments.recommendedPublication.logo_urlstringnullable

Publication logo URL.

item.comment.attachments.recommendedPublication.logo_url_widestringnullable

Wide publication logo URL.

item.comment.attachments.recommendedPublication.cover_photo_urlstringnullable

Publication cover image URL.

item.comment.attachments.recommendedPublication.created_atstringnullable

Publication creation timestamp.

item.comment.attachments.recommendedPublication.languagestringnullable

Publication language code.

item.comment.attachments.recommendedPublication.copyrightstringnullable

Published copyright attribution.

item.comment.attachments.recommendedPublication.typestringnullable

Publication type as reported by Substack.

item.comment.attachments.recommendedPublication.has_postsbooleannullable

Whether the publication reports posts.

item.comment.attachments.recommendedPublication.has_podcastbooleannullable

Whether the publication reports a podcast.

item.comment.attachments.recommendedPublication.has_recommendationsbooleannullable

Whether the publication reports recommendations.

item.comment.attachments.recommendedPublication.podcast_titlestringnullable

Published podcast title.

item.comment.attachments.recommendedPublication.podcast_descriptionstringnullable

Published podcast description.

item.comment.attachments.recommendedPublication.podcast_feed_urlstringnullable

Published podcast feed URL.

item.comment.attachments.recommendedPublication.podcast_art_urlstringnullable

Podcast artwork URL.

item.comment.attachments.recommendedPublication.freeSubscriberCountstringnullable

Displayed free-subscriber count text.

item.comment.attachments.recommendedPublication.rankingDetailstringnullable

Published subscriber-ranking description.

item.comment.attachments.recommendedPublication.author_bestseller_tierintegernullable

Author bestseller tier.

item.comment.attachments.recommendedPublication.sectionsobject[]

Publication sections in source order.

up to 100 items

Publication making the recommendation in this attachment.

item.comment.attachments.recommendingPublication.idinteger

Numeric publication ID.

0 – 9007199254740991

item.comment.attachments.recommendingPublication.namestring

Publication name.

item.comment.attachments.recommendingPublication.subdomainstring

Substack publication subdomain.

item.comment.attachments.recommendingPublication.custom_domainstringnullable

Published custom-domain name, or null.

item.comment.attachments.recommendingPublication.author_idintegernullable

Publication owner’s numeric user ID.

item.comment.attachments.recommendingPublication.author_namestringnullable

Publication owner’s public name.

item.comment.attachments.recommendingPublication.author_handlestringnullable

Publication owner’s public handle.

item.comment.attachments.recommendingPublication.author_photo_urlstringnullable

Public author profile image URL.

item.comment.attachments.recommendingPublication.author_biostringnullable

Public author biography.

item.comment.attachments.recommendingPublication.twitter_screen_namestringnullable

Published X username.

item.comment.attachments.recommendingPublication.descriptionstringnullable

Publication description.

item.comment.attachments.recommendingPublication.hero_textstringnullable

Publication introduction text.

item.comment.attachments.recommendingPublication.logo_urlstringnullable

Publication logo URL.

item.comment.attachments.recommendingPublication.logo_url_widestringnullable

Wide publication logo URL.

item.comment.attachments.recommendingPublication.cover_photo_urlstringnullable

Publication cover image URL.

item.comment.attachments.recommendingPublication.created_atstringnullable

Publication creation timestamp.

item.comment.attachments.recommendingPublication.languagestringnullable

Publication language code.

item.comment.attachments.recommendingPublication.copyrightstringnullable

Published copyright attribution.

item.comment.attachments.recommendingPublication.typestringnullable

Publication type as reported by Substack.

item.comment.attachments.recommendingPublication.has_postsbooleannullable

Whether the publication reports posts.

item.comment.attachments.recommendingPublication.has_podcastbooleannullable

Whether the publication reports a podcast.

item.comment.attachments.recommendingPublication.has_recommendationsbooleannullable

Whether the publication reports recommendations.

item.comment.attachments.recommendingPublication.podcast_titlestringnullable

Published podcast title.

item.comment.attachments.recommendingPublication.podcast_descriptionstringnullable

Published podcast description.

item.comment.attachments.recommendingPublication.podcast_feed_urlstringnullable

Published podcast feed URL.

item.comment.attachments.recommendingPublication.podcast_art_urlstringnullable

Podcast artwork URL.

item.comment.attachments.recommendingPublication.freeSubscriberCountstringnullable

Displayed free-subscriber count text.

item.comment.attachments.recommendingPublication.rankingDetailstringnullable

Published subscriber-ranking description.

item.comment.attachments.recommendingPublication.author_bestseller_tierintegernullable

Author bestseller tier.

item.comment.attachments.recommendingPublication.sectionsobject[]

Publication sections in source order.

up to 100 items

item.comment.attachments.imageUrlstringnullable

Published attachment image URL.

item.comment.attachments.imageWidthintegernullable

Attachment image width in pixels.

item.comment.attachments.imageHeightintegernullable

Attachment image height in pixels.

item.comment.attachments.explicitbooleannullable

Published explicit-content flag.

Published excerpt selection from an attached post.

item.comment.attachments.postSelection.idstringnullable

Source excerpt-selection identifier.

item.comment.attachments.postSelection.created_atstringnullable

Excerpt-selection creation timestamp.

item.comment.attachments.postSelection.post_idintegernullable

Selected post’s numeric ID.

item.comment.attachments.postSelection.start_paragraphintegernullable

Source-reported first selected paragraph index.

item.comment.attachments.postSelection.end_paragraphintegernullable

Source-reported final selected paragraph index.

item.comment.attachments.postSelection.start_offsetintegernullable

Source-reported starting text offset.

item.comment.attachments.postSelection.end_offsetintegernullable

Source-reported ending text offset.

item.comment.attachments.postSelection.textstringnullable

Published selected text.

item.comment.attachments.postSelection.is_auto_selectionbooleannullable

Whether the source marks the excerpt as automatically selected.

Attached publication metadata.

item.comment.attachments.publication.idinteger

Numeric publication ID.

0 – 9007199254740991

item.comment.attachments.publication.namestring

Publication name.

item.comment.attachments.publication.subdomainstring

Substack publication subdomain.

item.comment.attachments.publication.custom_domainstringnullable

Published custom-domain name, or null.

item.comment.attachments.publication.author_idintegernullable

Publication owner’s numeric user ID.

item.comment.attachments.publication.author_namestringnullable

Publication owner’s public name.

item.comment.attachments.publication.author_handlestringnullable

Publication owner’s public handle.

item.comment.attachments.publication.author_photo_urlstringnullable

Public author profile image URL.

item.comment.attachments.publication.author_biostringnullable

Public author biography.

item.comment.attachments.publication.twitter_screen_namestringnullable

Published X username.

item.comment.attachments.publication.descriptionstringnullable

Publication description.

item.comment.attachments.publication.hero_textstringnullable

Publication introduction text.

item.comment.attachments.publication.logo_urlstringnullable

Publication logo URL.

item.comment.attachments.publication.logo_url_widestringnullable

Wide publication logo URL.

item.comment.attachments.publication.cover_photo_urlstringnullable

Publication cover image URL.

item.comment.attachments.publication.created_atstringnullable

Publication creation timestamp.

item.comment.attachments.publication.languagestringnullable

Publication language code.

item.comment.attachments.publication.copyrightstringnullable

Published copyright attribution.

item.comment.attachments.publication.typestringnullable

Publication type as reported by Substack.

item.comment.attachments.publication.has_postsbooleannullable

Whether the publication reports posts.

item.comment.attachments.publication.has_podcastbooleannullable

Whether the publication reports a podcast.

item.comment.attachments.publication.has_recommendationsbooleannullable

Whether the publication reports recommendations.

item.comment.attachments.publication.podcast_titlestringnullable

Published podcast title.

item.comment.attachments.publication.podcast_descriptionstringnullable

Published podcast description.

item.comment.attachments.publication.podcast_feed_urlstringnullable

Published podcast feed URL.

item.comment.attachments.publication.podcast_art_urlstringnullable

Podcast artwork URL.

item.comment.attachments.publication.freeSubscriberCountstringnullable

Displayed free-subscriber count text.

item.comment.attachments.publication.rankingDetailstringnullable

Published subscriber-ranking description.

item.comment.attachments.publication.author_bestseller_tierintegernullable

Author bestseller tier.

item.comment.attachments.publication.sectionsobject[]

Publication sections in source order.

up to 100 items

Attached post metadata.

item.comment.attachments.post.idinteger

Numeric post ID.

0 – 9007199254740991

item.comment.attachments.post.publication_idinteger

Owning publication’s numeric ID.

0 – 9007199254740991

item.comment.attachments.post.slugstring

Post URL slug.

item.comment.attachments.post.titlestring

Post title.

item.comment.attachments.post.subtitlestringnullable

Post subtitle.

item.comment.attachments.post.typestringnullable

Post type as reported by Substack.

item.comment.attachments.post.audiencestringnullable

Post audience label.

item.comment.attachments.post.canonical_urlstringnullable

Canonical post URL.

item.comment.attachments.post.post_datestringnullable

Publication timestamp.

item.comment.attachments.post.updated_atstringnullable

Post update timestamp.

item.comment.attachments.post.descriptionstringnullable

Post summary.

item.comment.attachments.post.body_htmlstringnullable

Published article HTML.

item.comment.attachments.post.truncated_body_textstringnullable

Published plain-text excerpt.

item.comment.attachments.post.cover_imagestringnullable

Post cover image URL.

item.comment.attachments.post.wordcountintegernullable

Source-reported article word count.

item.comment.attachments.post.languagestringnullable

Post language code.

item.comment.attachments.post.reaction_countintegernullable

Post reaction count.

item.comment.attachments.post.reactionsobject

Reaction counts keyed by reaction type.

item.comment.attachments.post.restacksintegernullable

Post restack count.

item.comment.attachments.post.comment_countintegernullable

Post comment count.

item.comment.attachments.post.child_comment_countintegernullable

Nested comment count reported for the post.

item.comment.attachments.post.podcast_urlstringnullable

Published podcast audio URL.

item.comment.attachments.post.podcast_durationnumbernullable

Source-reported podcast duration.

item.comment.attachments.post.podcast_art_urlstringnullable

Podcast artwork URL.

item.comment.attachments.post.video_upload_idstringnullable

Published video upload identifier.

item.comment.attachments.post.podcast_upload_idstringnullable

Published podcast upload identifier.

item.comment.attachments.post.voiceover_upload_idstringnullable

Published voiceover upload identifier.

item.comment.attachments.post.write_comment_permissionsstringnullable

Published comment-permission label.

item.comment.attachments.post.section_idintegernullable

Publication section ID.

item.comment.attachments.post.section_namestringnullable

Publication section name.

item.comment.attachments.post.section_slugstringnullable

Publication section slug.

item.comment.attachments.post.previous_post_slugstringnullable

Previous post slug when published.

item.comment.attachments.post.next_post_slugstringnullable

Next post slug when published.

item.comment.attachments.post.is_geoblockedbooleannullable

Published geoblocking flag.

item.comment.attachments.post.is_publishedbooleannullable

Published-state flag.

item.comment.attachments.post.publishedBylinesobject[]

Public author bylines.

up to 100 items

item.comment.attachments.post.postTagsobject[]

Post tags.

up to 100 items

item.comment.attachments.post.mediaobject[]

Published audio and video metadata.

up to 100 items

Attached comment metadata.

item.comment.attachments.comment.idinteger

Numeric comment ID.

0 – 9007199254740991

item.comment.attachments.comment.bodystringnullable

Published comment text.

item.comment.attachments.comment.body_jsonobjectnullable

Published rich-text document with formatting and links.

item.comment.attachments.comment.publication_idintegernullable

Publication ID.

item.comment.attachments.comment.post_idintegernullable

Post ID.

item.comment.attachments.comment.user_idintegernullable

Comment author’s numeric user ID.

item.comment.attachments.comment.ancestor_pathstringnullable

Source-reported ancestor path.

item.comment.attachments.comment.typestringnullable

Comment type reported by Substack.

item.comment.attachments.comment.deletedbooleannullable

Published deletion flag.

item.comment.attachments.comment.datestringnullable

Comment publication timestamp.

item.comment.attachments.comment.edited_atstringnullable

Comment edit timestamp.

item.comment.attachments.comment.namestringnullable

Public commenter name.

item.comment.attachments.comment.photo_urlstringnullable

Commenter image URL.

item.comment.attachments.comment.handlestringnullable

Public commenter handle.

item.comment.attachments.comment.user_slugstringnullable

Public commenter profile slug.

item.comment.attachments.comment.reaction_countintegernullable

Comment reaction count.

item.comment.attachments.comment.reactionsobject

Reaction counts keyed by reaction type.

item.comment.attachments.comment.restacksintegernullable

Comment restack count.

item.comment.attachments.comment.children_countintegernullable

Source-reported reply count.

item.comment.attachments.comment.parentIdintegernullable

Parent comment ID, or null for a top-level comment.

item.comment.attachments.comment.depthinteger

Reply depth; top-level comments have depth zero.

≥ 0

Publication associated with the entry.

item.publication.idinteger

Numeric publication ID.

0 – 9007199254740991

item.publication.namestring

Publication name.

item.publication.subdomainstring

Substack publication subdomain.

item.publication.custom_domainstringnullable

Published custom-domain name, or null.

item.publication.author_idintegernullable

Publication owner’s numeric user ID.

item.publication.author_namestringnullable

Publication owner’s public name.

item.publication.author_handlestringnullable

Publication owner’s public handle.

item.publication.author_photo_urlstringnullable

Public author profile image URL.

item.publication.author_biostringnullable

Public author biography.

item.publication.twitter_screen_namestringnullable

Published X username.

item.publication.descriptionstringnullable

Publication description.

item.publication.hero_textstringnullable

Publication introduction text.

item.publication.logo_urlstringnullable

Publication logo URL.

item.publication.logo_url_widestringnullable

Wide publication logo URL.

item.publication.cover_photo_urlstringnullable

Publication cover image URL.

item.publication.created_atstringnullable

Publication creation timestamp.

item.publication.languagestringnullable

Publication language code.

item.publication.copyrightstringnullable

Published copyright attribution.

item.publication.typestringnullable

Publication type as reported by Substack.

item.publication.has_postsbooleannullable

Whether the publication reports posts.

item.publication.has_podcastbooleannullable

Whether the publication reports a podcast.

item.publication.has_recommendationsbooleannullable

Whether the publication reports recommendations.

item.publication.podcast_titlestringnullable

Published podcast title.

item.publication.podcast_descriptionstringnullable

Published podcast description.

item.publication.podcast_feed_urlstringnullable

Published podcast feed URL.

item.publication.podcast_art_urlstringnullable

Podcast artwork URL.

item.publication.freeSubscriberCountstringnullable

Displayed free-subscriber count text.

item.publication.rankingDetailstringnullable

Published subscriber-ranking description.

item.publication.author_bestseller_tierintegernullable

Author bestseller tier.

Publication sections in source order.

up to 100 items

item.publication.sections.idinteger

Numeric section ID.

0 – 9007199254740991

item.publication.sections.namestringnullable

Section name.

item.publication.sections.slugstringnullable

Section URL slug.

item.publication.sections.descriptionstringnullable

Section description.

item.publication.sections.is_podcastbooleannullable

Whether this section is a podcast.

Parent Notes for the surrounding conversation.

up to 100 items

item.parentComments.idinteger

Numeric comment ID.

0 – 9007199254740991

item.parentComments.bodystringnullable

Published comment text.

item.parentComments.body_jsonobjectnullable

Published rich-text document with formatting and links.

item.parentComments.publication_idintegernullable

Publication ID.

item.parentComments.post_idintegernullable

Post ID.

item.parentComments.user_idintegernullable

Comment author’s numeric user ID.

item.parentComments.ancestor_pathstringnullable

Source-reported ancestor path.

item.parentComments.typestringnullable

Comment type reported by Substack.

item.parentComments.deletedbooleannullable

Published deletion flag.

item.parentComments.datestringnullable

Comment publication timestamp.

item.parentComments.edited_atstringnullable

Comment edit timestamp.

item.parentComments.namestringnullable

Public commenter name.

item.parentComments.photo_urlstringnullable

Commenter image URL.

item.parentComments.handlestringnullable

Public commenter handle.

item.parentComments.user_slugstringnullable

Public commenter profile slug.

item.parentComments.reaction_countintegernullable

Comment reaction count.

item.parentComments.reactionsobject

Reaction counts keyed by reaction type.

item.parentComments.restacksintegernullable

Comment restack count.

item.parentComments.children_countintegernullable

Source-reported reply count.

item.parentComments.parentIdintegernullable

Parent comment ID, or null for a top-level comment.

item.parentComments.depthinteger

Reply depth; top-level comments have depth zero.

≥ 0

item.parentComments.biostringnullable

Public Note author biography.

item.parentComments.languagestringnullable

Note language code.

item.parentComments.user_bestseller_tierintegernullable

Note author bestseller tier.

Note author’s primary publication.

item.parentComments.user_primary_publication.idinteger

Numeric publication ID.

0 – 9007199254740991

item.parentComments.user_primary_publication.namestring

Publication name.

item.parentComments.user_primary_publication.subdomainstring

Substack publication subdomain.

item.parentComments.user_primary_publication.custom_domainstringnullable

Published custom-domain name, or null.

item.parentComments.user_primary_publication.author_idintegernullable

Publication owner’s numeric user ID.

item.parentComments.user_primary_publication.author_namestringnullable

Publication owner’s public name.

item.parentComments.user_primary_publication.author_handlestringnullable

Publication owner’s public handle.

item.parentComments.user_primary_publication.author_photo_urlstringnullable

Public author profile image URL.

item.parentComments.user_primary_publication.author_biostringnullable

Public author biography.

item.parentComments.user_primary_publication.twitter_screen_namestringnullable

Published X username.

item.parentComments.user_primary_publication.descriptionstringnullable

Publication description.

item.parentComments.user_primary_publication.hero_textstringnullable

Publication introduction text.

item.parentComments.user_primary_publication.logo_urlstringnullable

Publication logo URL.

item.parentComments.user_primary_publication.logo_url_widestringnullable

Wide publication logo URL.

item.parentComments.user_primary_publication.cover_photo_urlstringnullable

Publication cover image URL.

item.parentComments.user_primary_publication.created_atstringnullable

Publication creation timestamp.

item.parentComments.user_primary_publication.languagestringnullable

Publication language code.

item.parentComments.user_primary_publication.copyrightstringnullable

Published copyright attribution.

item.parentComments.user_primary_publication.typestringnullable

Publication type as reported by Substack.

item.parentComments.user_primary_publication.has_postsbooleannullable

Whether the publication reports posts.

item.parentComments.user_primary_publication.has_podcastbooleannullable

Whether the publication reports a podcast.

item.parentComments.user_primary_publication.has_recommendationsbooleannullable

Whether the publication reports recommendations.

item.parentComments.user_primary_publication.podcast_titlestringnullable

Published podcast title.

item.parentComments.user_primary_publication.podcast_descriptionstringnullable

Published podcast description.

item.parentComments.user_primary_publication.podcast_feed_urlstringnullable

Published podcast feed URL.

item.parentComments.user_primary_publication.podcast_art_urlstringnullable

Podcast artwork URL.

item.parentComments.user_primary_publication.freeSubscriberCountstringnullable

Displayed free-subscriber count text.

item.parentComments.user_primary_publication.rankingDetailstringnullable

Published subscriber-ranking description.

item.parentComments.user_primary_publication.author_bestseller_tierintegernullable

Author bestseller tier.

Publication sections in source order.

up to 100 items

item.parentComments.user_primary_publication.sections.idinteger

Numeric section ID.

0 – 9007199254740991

item.parentComments.user_primary_publication.sections.namestringnullable

Section name.

item.parentComments.user_primary_publication.sections.slugstringnullable

Section URL slug.

item.parentComments.user_primary_publication.sections.descriptionstringnullable

Section description.

item.parentComments.user_primary_publication.sections.is_podcastbooleannullable

Whether this section is a podcast.

Published Note attachments.

up to 100 items

item.parentComments.attachments.idstring | integernullable

Source attachment identifier, a string or number.

item.parentComments.attachments.typestringnullable

Attachment type reported by Substack.

item.parentComments.attachments.urlstringnullable

Published attachment URL.

item.parentComments.attachments.thumbnailstringnullable

Attachment preview image URL.

Publication recommended in this attachment.

item.parentComments.attachments.recommendedPublication.idinteger

Numeric publication ID.

0 – 9007199254740991

item.parentComments.attachments.recommendedPublication.namestring

Publication name.

item.parentComments.attachments.recommendedPublication.subdomainstring

Substack publication subdomain.

item.parentComments.attachments.recommendedPublication.custom_domainstringnullable

Published custom-domain name, or null.

item.parentComments.attachments.recommendedPublication.author_idintegernullable

Publication owner’s numeric user ID.

item.parentComments.attachments.recommendedPublication.author_namestringnullable

Publication owner’s public name.

item.parentComments.attachments.recommendedPublication.author_handlestringnullable

Publication owner’s public handle.

item.parentComments.attachments.recommendedPublication.author_photo_urlstringnullable

Public author profile image URL.

item.parentComments.attachments.recommendedPublication.author_biostringnullable

Public author biography.

item.parentComments.attachments.recommendedPublication.twitter_screen_namestringnullable

Published X username.

item.parentComments.attachments.recommendedPublication.descriptionstringnullable

Publication description.

item.parentComments.attachments.recommendedPublication.hero_textstringnullable

Publication introduction text.

item.parentComments.attachments.recommendedPublication.logo_urlstringnullable

Publication logo URL.

item.parentComments.attachments.recommendedPublication.logo_url_widestringnullable

Wide publication logo URL.

item.parentComments.attachments.recommendedPublication.cover_photo_urlstringnullable

Publication cover image URL.

item.parentComments.attachments.recommendedPublication.created_atstringnullable

Publication creation timestamp.

item.parentComments.attachments.recommendedPublication.languagestringnullable

Publication language code.

item.parentComments.attachments.recommendedPublication.copyrightstringnullable

Published copyright attribution.

item.parentComments.attachments.recommendedPublication.typestringnullable

Publication type as reported by Substack.

item.parentComments.attachments.recommendedPublication.has_postsbooleannullable

Whether the publication reports posts.

item.parentComments.attachments.recommendedPublication.has_podcastbooleannullable

Whether the publication reports a podcast.

item.parentComments.attachments.recommendedPublication.has_recommendationsbooleannullable

Whether the publication reports recommendations.

item.parentComments.attachments.recommendedPublication.podcast_titlestringnullable

Published podcast title.

item.parentComments.attachments.recommendedPublication.podcast_descriptionstringnullable

Published podcast description.

item.parentComments.attachments.recommendedPublication.podcast_feed_urlstringnullable

Published podcast feed URL.

item.parentComments.attachments.recommendedPublication.podcast_art_urlstringnullable

Podcast artwork URL.

item.parentComments.attachments.recommendedPublication.freeSubscriberCountstringnullable

Displayed free-subscriber count text.

item.parentComments.attachments.recommendedPublication.rankingDetailstringnullable

Published subscriber-ranking description.

item.parentComments.attachments.recommendedPublication.author_bestseller_tierintegernullable

Author bestseller tier.

item.parentComments.attachments.recommendedPublication.sectionsobject[]

Publication sections in source order.

up to 100 items

Publication making the recommendation in this attachment.

item.parentComments.attachments.recommendingPublication.idinteger

Numeric publication ID.

0 – 9007199254740991

item.parentComments.attachments.recommendingPublication.namestring

Publication name.

item.parentComments.attachments.recommendingPublication.subdomainstring

Substack publication subdomain.

item.parentComments.attachments.recommendingPublication.custom_domainstringnullable

Published custom-domain name, or null.

item.parentComments.attachments.recommendingPublication.author_idintegernullable

Publication owner’s numeric user ID.

item.parentComments.attachments.recommendingPublication.author_namestringnullable

Publication owner’s public name.

item.parentComments.attachments.recommendingPublication.author_handlestringnullable

Publication owner’s public handle.

item.parentComments.attachments.recommendingPublication.author_photo_urlstringnullable

Public author profile image URL.

item.parentComments.attachments.recommendingPublication.author_biostringnullable

Public author biography.

item.parentComments.attachments.recommendingPublication.twitter_screen_namestringnullable

Published X username.

item.parentComments.attachments.recommendingPublication.descriptionstringnullable

Publication description.

item.parentComments.attachments.recommendingPublication.hero_textstringnullable

Publication introduction text.

item.parentComments.attachments.recommendingPublication.logo_urlstringnullable

Publication logo URL.

item.parentComments.attachments.recommendingPublication.logo_url_widestringnullable

Wide publication logo URL.

item.parentComments.attachments.recommendingPublication.cover_photo_urlstringnullable

Publication cover image URL.

item.parentComments.attachments.recommendingPublication.created_atstringnullable

Publication creation timestamp.

item.parentComments.attachments.recommendingPublication.languagestringnullable

Publication language code.

item.parentComments.attachments.recommendingPublication.copyrightstringnullable

Published copyright attribution.

item.parentComments.attachments.recommendingPublication.typestringnullable

Publication type as reported by Substack.

item.parentComments.attachments.recommendingPublication.has_postsbooleannullable

Whether the publication reports posts.

item.parentComments.attachments.recommendingPublication.has_podcastbooleannullable

Whether the publication reports a podcast.

item.parentComments.attachments.recommendingPublication.has_recommendationsbooleannullable

Whether the publication reports recommendations.

item.parentComments.attachments.recommendingPublication.podcast_titlestringnullable

Published podcast title.

item.parentComments.attachments.recommendingPublication.podcast_descriptionstringnullable

Published podcast description.

item.parentComments.attachments.recommendingPublication.podcast_feed_urlstringnullable

Published podcast feed URL.

item.parentComments.attachments.recommendingPublication.podcast_art_urlstringnullable

Podcast artwork URL.

item.parentComments.attachments.recommendingPublication.freeSubscriberCountstringnullable

Displayed free-subscriber count text.

item.parentComments.attachments.recommendingPublication.rankingDetailstringnullable

Published subscriber-ranking description.

item.parentComments.attachments.recommendingPublication.author_bestseller_tierintegernullable

Author bestseller tier.

item.parentComments.attachments.recommendingPublication.sectionsobject[]

Publication sections in source order.

up to 100 items

item.parentComments.attachments.imageUrlstringnullable

Published attachment image URL.

item.parentComments.attachments.imageWidthintegernullable

Attachment image width in pixels.

item.parentComments.attachments.imageHeightintegernullable

Attachment image height in pixels.

item.parentComments.attachments.explicitbooleannullable

Published explicit-content flag.

Published excerpt selection from an attached post.

item.parentComments.attachments.postSelection.idstringnullable

Source excerpt-selection identifier.

item.parentComments.attachments.postSelection.created_atstringnullable

Excerpt-selection creation timestamp.

item.parentComments.attachments.postSelection.post_idintegernullable

Selected post’s numeric ID.

item.parentComments.attachments.postSelection.start_paragraphintegernullable

Source-reported first selected paragraph index.

item.parentComments.attachments.postSelection.end_paragraphintegernullable

Source-reported final selected paragraph index.

item.parentComments.attachments.postSelection.start_offsetintegernullable

Source-reported starting text offset.

item.parentComments.attachments.postSelection.end_offsetintegernullable

Source-reported ending text offset.

item.parentComments.attachments.postSelection.textstringnullable

Published selected text.

item.parentComments.attachments.postSelection.is_auto_selectionbooleannullable

Whether the source marks the excerpt as automatically selected.

Attached publication metadata.

item.parentComments.attachments.publication.idinteger

Numeric publication ID.

0 – 9007199254740991

item.parentComments.attachments.publication.namestring

Publication name.

item.parentComments.attachments.publication.subdomainstring

Substack publication subdomain.

item.parentComments.attachments.publication.custom_domainstringnullable

Published custom-domain name, or null.

item.parentComments.attachments.publication.author_idintegernullable

Publication owner’s numeric user ID.

item.parentComments.attachments.publication.author_namestringnullable

Publication owner’s public name.

item.parentComments.attachments.publication.author_handlestringnullable

Publication owner’s public handle.

item.parentComments.attachments.publication.author_photo_urlstringnullable

Public author profile image URL.

item.parentComments.attachments.publication.author_biostringnullable

Public author biography.

item.parentComments.attachments.publication.twitter_screen_namestringnullable

Published X username.

item.parentComments.attachments.publication.descriptionstringnullable

Publication description.

item.parentComments.attachments.publication.hero_textstringnullable

Publication introduction text.

item.parentComments.attachments.publication.logo_urlstringnullable

Publication logo URL.

item.parentComments.attachments.publication.logo_url_widestringnullable

Wide publication logo URL.

item.parentComments.attachments.publication.cover_photo_urlstringnullable

Publication cover image URL.

item.parentComments.attachments.publication.created_atstringnullable

Publication creation timestamp.

item.parentComments.attachments.publication.languagestringnullable

Publication language code.

item.parentComments.attachments.publication.copyrightstringnullable

Published copyright attribution.

item.parentComments.attachments.publication.typestringnullable

Publication type as reported by Substack.

item.parentComments.attachments.publication.has_postsbooleannullable

Whether the publication reports posts.

item.parentComments.attachments.publication.has_podcastbooleannullable

Whether the publication reports a podcast.

item.parentComments.attachments.publication.has_recommendationsbooleannullable

Whether the publication reports recommendations.

item.parentComments.attachments.publication.podcast_titlestringnullable

Published podcast title.

item.parentComments.attachments.publication.podcast_descriptionstringnullable

Published podcast description.

item.parentComments.attachments.publication.podcast_feed_urlstringnullable

Published podcast feed URL.

item.parentComments.attachments.publication.podcast_art_urlstringnullable

Podcast artwork URL.

item.parentComments.attachments.publication.freeSubscriberCountstringnullable

Displayed free-subscriber count text.

item.parentComments.attachments.publication.rankingDetailstringnullable

Published subscriber-ranking description.

item.parentComments.attachments.publication.author_bestseller_tierintegernullable

Author bestseller tier.

item.parentComments.attachments.publication.sectionsobject[]

Publication sections in source order.

up to 100 items

Attached post metadata.

item.parentComments.attachments.post.idinteger

Numeric post ID.

0 – 9007199254740991

item.parentComments.attachments.post.publication_idinteger

Owning publication’s numeric ID.

0 – 9007199254740991

item.parentComments.attachments.post.slugstring

Post URL slug.

item.parentComments.attachments.post.titlestring

Post title.

item.parentComments.attachments.post.subtitlestringnullable

Post subtitle.

item.parentComments.attachments.post.typestringnullable

Post type as reported by Substack.

item.parentComments.attachments.post.audiencestringnullable

Post audience label.

item.parentComments.attachments.post.canonical_urlstringnullable

Canonical post URL.

item.parentComments.attachments.post.post_datestringnullable

Publication timestamp.

item.parentComments.attachments.post.updated_atstringnullable

Post update timestamp.

item.parentComments.attachments.post.descriptionstringnullable

Post summary.

item.parentComments.attachments.post.body_htmlstringnullable

Published article HTML.

item.parentComments.attachments.post.truncated_body_textstringnullable

Published plain-text excerpt.

item.parentComments.attachments.post.cover_imagestringnullable

Post cover image URL.

item.parentComments.attachments.post.wordcountintegernullable

Source-reported article word count.

item.parentComments.attachments.post.languagestringnullable

Post language code.

item.parentComments.attachments.post.reaction_countintegernullable

Post reaction count.

item.parentComments.attachments.post.reactionsobject

Reaction counts keyed by reaction type.

item.parentComments.attachments.post.restacksintegernullable

Post restack count.

item.parentComments.attachments.post.comment_countintegernullable

Post comment count.

item.parentComments.attachments.post.child_comment_countintegernullable

Nested comment count reported for the post.

item.parentComments.attachments.post.podcast_urlstringnullable

Published podcast audio URL.

item.parentComments.attachments.post.podcast_durationnumbernullable

Source-reported podcast duration.

item.parentComments.attachments.post.podcast_art_urlstringnullable

Podcast artwork URL.

item.parentComments.attachments.post.video_upload_idstringnullable

Published video upload identifier.

item.parentComments.attachments.post.podcast_upload_idstringnullable

Published podcast upload identifier.

item.parentComments.attachments.post.voiceover_upload_idstringnullable

Published voiceover upload identifier.

item.parentComments.attachments.post.write_comment_permissionsstringnullable

Published comment-permission label.

item.parentComments.attachments.post.section_idintegernullable

Publication section ID.

item.parentComments.attachments.post.section_namestringnullable

Publication section name.

item.parentComments.attachments.post.section_slugstringnullable

Publication section slug.

item.parentComments.attachments.post.previous_post_slugstringnullable

Previous post slug when published.

item.parentComments.attachments.post.next_post_slugstringnullable

Next post slug when published.

item.parentComments.attachments.post.is_geoblockedbooleannullable

Published geoblocking flag.

item.parentComments.attachments.post.is_publishedbooleannullable

Published-state flag.

item.parentComments.attachments.post.publishedBylinesobject[]

Public author bylines.

up to 100 items

item.parentComments.attachments.post.postTagsobject[]

Post tags.

up to 100 items

item.parentComments.attachments.post.mediaobject[]

Published audio and video metadata.

up to 100 items

Attached comment metadata.

item.parentComments.attachments.comment.idinteger

Numeric comment ID.

0 – 9007199254740991

item.parentComments.attachments.comment.bodystringnullable

Published comment text.

item.parentComments.attachments.comment.body_jsonobjectnullable

Published rich-text document with formatting and links.

item.parentComments.attachments.comment.publication_idintegernullable

Publication ID.

item.parentComments.attachments.comment.post_idintegernullable

Post ID.

item.parentComments.attachments.comment.user_idintegernullable

Comment author’s numeric user ID.

item.parentComments.attachments.comment.ancestor_pathstringnullable

Source-reported ancestor path.

item.parentComments.attachments.comment.typestringnullable

Comment type reported by Substack.

item.parentComments.attachments.comment.deletedbooleannullable

Published deletion flag.

item.parentComments.attachments.comment.datestringnullable

Comment publication timestamp.

item.parentComments.attachments.comment.edited_atstringnullable

Comment edit timestamp.

item.parentComments.attachments.comment.namestringnullable

Public commenter name.

item.parentComments.attachments.comment.photo_urlstringnullable

Commenter image URL.

item.parentComments.attachments.comment.handlestringnullable

Public commenter handle.

item.parentComments.attachments.comment.user_slugstringnullable

Public commenter profile slug.

item.parentComments.attachments.comment.reaction_countintegernullable

Comment reaction count.

item.parentComments.attachments.comment.reactionsobject

Reaction counts keyed by reaction type.

item.parentComments.attachments.comment.restacksintegernullable

Comment restack count.

item.parentComments.attachments.comment.children_countintegernullable

Source-reported reply count.

item.parentComments.attachments.comment.parentIdintegernullable

Parent comment ID, or null for a top-level comment.

item.parentComments.attachments.comment.depthinteger

Reply depth; top-level comments have depth zero.

≥ 0

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes
15
HTTPfailure.codeMeaning
400invalid_requestMissing, duplicated, invalid or unsupported request parameters.
401unauthorizedMissing or invalid service API key.
404not_foundThe requested publication, post or profile was not found.
422restricted_pageThe requested content requires additional access.
422unsupported_pageThe source did not provide the expected record.
502upstream_challengedThe source challenged the request.
502upstream_rate_limitedThe source rate limited the request.
502upstream_errorA source request failed.
502response_too_largeSource data exceeded the response byte limit.
502payload_too_complexSource data exceeded the traversal depth or node limit.
502unsafe_redirectThe source returned an unexpected redirect.
502request_limitThe request exhausted its source-attempt budget.
503busyAll worker request slots are in use.
504timeoutThe request exceeded its deadline.
200partialUsable data was returned with coverage warnings.