Substack

Search Substack posts, notes and people

Search Substack posts, notes and profiles, cursor paged.

GET/v1/substack/search
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
2
querystringrequiredquery

Text to search posts, notes and profiles for.

min 1 chars · max 200 chars

cursorstringoptionalquery

Opaque cursor from the previous page's `nextCursor`.

max 4096 chars

Response fields
742

Endpoint-specific response payload.

datalookupStatus
string

Whether the search ran.

one of: found, not_found

dataquery
string

The query that was searched.

The matching feed items.

dataitems[]type
stringnullable

`post`, `comment`/note, or `profileSearchResults`.

dataitems[]id
stringnullable

Substack's entity key, e.g. `p-123` or `c-456`.

The post, when the item is a post.

dataitems[]postid
integer

Numeric post id.

dataitems[]postpublicationId
integernullable

Numeric publication id.

dataitems[]postslug
stringnullable

The post's URL slug.

dataitems[]posttitle
stringnullable

The post's title.

dataitems[]postsubtitle
stringnullable

The post's subtitle.

dataitems[]postdescription
stringnullable

The post's short description.

dataitems[]postkind
stringnullable

`newsletter`, `podcast`, `video` or `restack`.

dataitems[]postaudience
stringnullable

`everyone`, `only_paid`, `only_subscribers` or another value Substack uses.

dataitems[]postisPaywalled
booleannullable

Whether the post is paid.

dataitems[]posturl
stringnullable

Canonical post URL.

dataitems[]postpublishedAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]postupdatedAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]postlanguage
stringnullable

The post's language code.

dataitems[]postbodyHtml
stringnullable

Full body HTML for a free post; the preview only when `bodyIsPreview` is true.

dataitems[]postbodyIsPreview
boolean

True when the audience is not `everyone`.

dataitems[]postpreviewText
stringnullable

The public preview text.

dataitems[]postwordCount
integernullable

The post's word count.

dataitems[]postcommentCount
integernullable

The number of comments on the post.

dataitems[]postreplyCount
integernullable

Replies to comments on the post.

dataitems[]postreactionCount
integernullable

The number of reactions to the post.

dataitems[]postreactions
object

Emoji to reaction count.

dataitems[]postrestackCount
integernullable

The number of restacks.

dataitems[]postcommentPermission
stringnullable

Who may comment on the post.

dataitems[]postcoverImageUrl
stringnullable

The post's cover image URL.

dataitems[]postcoverImageIsSquare
booleannullable

Whether the cover image is square.

dataitems[]postcoverImageIsExplicit
booleannullable

Whether the cover image is explicit.

dataitems[]postisGeoblocked
booleannullable

Whether the post is geoblocked.

Countries where the post is blocked.

dataitems[]postblockedCountries[]
stringoptional
dataitems[]postliveStreamId
stringnullable

The live stream id, when the post is a live stream.

dataitems[]postisPublished
booleannullable

Whether the post is published.

dataitems[]postisPinned
booleannullable

Whether the post is pinned.

dataitems[]postseoTitle
stringnullable

The title shown to search engines.

dataitems[]postseoDescription
stringnullable

The description shown to search engines.

dataitems[]postsocialTitle
stringnullable

The title used for social previews.

dataitems[]postpreviousSlug
stringnullable

The previous post's slug.

dataitems[]postnextSlug
stringnullable

The next post's slug.

The section the post belongs to.

dataitems[]postsectionid
integernullable

Numeric section id.

dataitems[]postsectionname
stringnullable

The section's name.

dataitems[]postsectionslug
stringnullable

The section's URL slug.

The post's tags.

dataitems[]posttags[]id
integernullable

Numeric tag id.

dataitems[]posttags[]name
stringnullable

The tag's name.

dataitems[]posttags[]slug
stringnullable

The tag's URL slug.

dataitems[]posttags[]hidden
booleannullable

Whether the tag is hidden.

The post's authors.

dataitems[]postauthors[]id
integernullable

Numeric user id.

dataitems[]postauthors[]name
stringnullable

The name shown for the author.

dataitems[]postauthors[]handle
stringnullable

The author's handle.

dataitems[]postauthors[]slug
stringnullable

The author's profile slug.

dataitems[]postauthors[]bio
stringnullable

The author's short biography.

dataitems[]postauthors[]photoUrl
stringnullable

The author's profile photo URL.

The author's main badge, when there is one.

dataitems[]postauthors[]badgetype
stringnullable

The kind of badge, such as `bestseller`.

dataitems[]postauthors[]badgetier
integernullable

The badge tier, when it has one.

dataitems[]postauthors[]badgehandle
stringnullable

The handle the badge belongs to.

dataitems[]postauthors[]badgeservice
stringnullable

The service the badge comes from.

dataitems[]postauthors[]badgeurl
stringnullable

A link for the badge, when it has one.

dataitems[]postauthors[]badges
objectnullable

The author's reader status fields, when available.

dataitems[]postauthors[]bestsellerTier
integernullable

The author's bestseller tier.

The author's primary publication, when there is one.

dataitems[]postauthors[]primaryPublicationid
integernullable

Numeric publication id.

dataitems[]postauthors[]primaryPublicationname
stringnullable

The publication's name.

dataitems[]postauthors[]primaryPublicationsubdomain
stringnullable

The publication's Substack subdomain.

dataitems[]postauthors[]primaryPublicationcustomDomain
stringnullable

The publication's custom domain, when it has one.

dataitems[]postauthors[]primaryPublicationlogoUrl
stringnullable

The publication's logo URL.

Podcast metadata, when the post is an episode.

dataitems[]postpodcastepisodeNumber
integernullable

The episode number.

dataitems[]postpodcastseasonNumber
integernullable

The season number.

dataitems[]postpodcastepisodeType
stringnullable

The episode type.

Audio, when the post has any.

dataitems[]postaudiourl
stringnullable

Audio file URL.

dataitems[]postaudiodurationSeconds
numbernullable

Audio length in seconds.

dataitems[]postaudiofileSizeBytes
integernullable

Audio file size in bytes.

dataitems[]postaudiomediaType
stringnullable

The upload's media label, such as `audio`.

dataitems[]postaudioepisodeImageUrl
stringnullable

Artwork for the episode.

Generated or uploaded audio items.

dataitems[]postaudioitems[]postId
integernullable

Numeric post id.

dataitems[]postaudioitems[]voiceId
stringnullable

The voice used for generated audio.

dataitems[]postaudioitems[]audioUrl
stringnullable

The audio file URL.

dataitems[]postaudioitems[]type
stringnullable

`tts` or Substack's own audio type.

dataitems[]postaudioitems[]status
stringnullable

The audio item's status.

Video, when the post has any.

dataitems[]postvideodurationSeconds
numbernullable

Video length in seconds.

dataitems[]postvideowidth
integernullable

Video width in pixels.

dataitems[]postvideoheight
integernullable

Video height in pixels.

dataitems[]postvideoplaybackId
stringnullable

The playback id of the hosted video stream.

dataitems[]postvideoisMux
booleannullable

Whether the video uses Substack's hosted player.

The note, when the item is a note.

dataitems[]noteid
integer

Numeric note id.

dataitems[]notebody
stringnullable

The note's plain text.

dataitems[]notebodyJson
objectnullable

The note's rich text document, when there is one.

dataitems[]notecreatedAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]noteeditedAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

The note's author.

dataitems[]noteauthorid
integernullable

Numeric user id.

dataitems[]noteauthorname
stringnullable

The name shown for the author.

dataitems[]noteauthorhandle
stringnullable

The author's handle.

dataitems[]noteauthorslug
stringnullable

The author's profile slug.

dataitems[]noteauthorbio
stringnullable

The author's short biography.

dataitems[]noteauthorphotoUrl
stringnullable

The author's profile photo URL.

The author's main badge, when there is one.

dataitems[]noteauthorbadgetype
stringnullable

The kind of badge, such as `bestseller`.

dataitems[]noteauthorbadgetier
integernullable

The badge tier, when it has one.

dataitems[]noteauthorbadgehandle
stringnullable

The handle the badge belongs to.

dataitems[]noteauthorbadgeservice
stringnullable

The service the badge comes from.

dataitems[]noteauthorbadgeurl
stringnullable

A link for the badge, when it has one.

dataitems[]noteauthorbadges
objectnullable

The author's reader status fields, when available.

dataitems[]noteauthorbestsellerTier
integernullable

The author's bestseller tier.

The author's primary publication, when there is one.

dataitems[]noteauthorprimaryPublicationid
integernullable

Numeric publication id.

dataitems[]noteauthorprimaryPublicationname
stringnullable

The publication's name.

dataitems[]noteauthorprimaryPublicationsubdomain
stringnullable

The publication's Substack subdomain.

dataitems[]noteauthorprimaryPublicationcustomDomain
stringnullable

The publication's custom domain, when it has one.

dataitems[]noteauthorprimaryPublicationlogoUrl
stringnullable

The publication's logo URL.

dataitems[]notereactionCount
integernullable

The number of reactions.

dataitems[]notereactions
object

Emoji to reaction count.

dataitems[]noterestackCount
integernullable

The number of restacks.

dataitems[]notereplyCount
integernullable

The number of replies.

dataitems[]notelanguage
stringnullable

The note's language code.

dataitems[]noteisAiGenerated
booleannullable

Substack's own flag.

dataitems[]notetranslation
objectnullable

A translation of the note, when there is one.

dataitems[]notereplyPermission
stringnullable

Who may reply to the note.

dataitems[]noteancestorPath
stringnullable

The note's position in a thread.

Images, links, posts or polls attached to the note.

dataitems[]noteattachments[]id
stringnullable

The attachment's id.

dataitems[]noteattachments[]type
stringnullable

`image`, `link`, `post`, `poll` or `missing`.

dataitems[]noteattachments[]imageUrl
stringnullable

The image URL, for an image attachment.

dataitems[]noteattachments[]imageWidth
integernullable

The image width in pixels.

dataitems[]noteattachments[]imageHeight
integernullable

The image height in pixels.

dataitems[]noteattachments[]explicit
booleannullable

Whether the attachment is explicit.

Preview metadata for a link attachment.

dataitems[]noteattachments[]linkurl
stringnullable

The link's URL.

dataitems[]noteattachments[]linkhost
stringnullable

The link's host.

dataitems[]noteattachments[]linktitle
stringnullable

The link's title.

dataitems[]noteattachments[]linkdescription
stringnullable

The link's description.

dataitems[]noteattachments[]linkimage
stringnullable

The link's preview image URL.

dataitems[]noteattachments[]linkoriginalImage
stringnullable

The link's original image URL.

dataitems[]noteattachments[]postId
integernullable

The attached post's id.

dataitems[]noteattachments[]publicationId
integernullable

The attached publication's id.

dataitems[]noteattachments[]reason
stringnullable

Why a missing attachment was removed.

The publication behind the item.

dataitems[]publicationid
integer

Numeric publication id.

dataitems[]publicationname
stringnullable

The publication's name.

dataitems[]publicationsubdomain
stringnullable

The publication's Substack subdomain.

dataitems[]publicationcustomDomain
stringnullable

The publication's custom domain, when it has one.

dataitems[]publicationapexDomain
stringnullable

The publication's apex domain, when it has one.

dataitems[]publicationurl
stringnullable

The publication's canonical base URL.

dataitems[]publicationhost
stringnullable

The host its pages are served from.

dataitems[]publicationdescription
stringnullable

The publication's description.

dataitems[]publicationlanguage
stringnullable

The publication's language code.

dataitems[]publicationkind
stringnullable

`newsletter`, `podcast` or Substack's own type.

dataitems[]publicationcreatedAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]publicationfirstPostAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]publicationhasPosts
booleannullable

Whether the publication has posts.

dataitems[]publicationisExplicit
booleannullable

Whether the publication is marked explicit.

dataitems[]publicationisInviteOnly
booleannullable

Whether the publication is invite-only.

dataitems[]publicationisFlagged
booleannullable

Whether the publication is flagged.

dataitems[]publicationnoIndex
booleannullable

Whether search engines are asked not to index it.

dataitems[]publicationisOnSubstack
booleannullable

Whether the publication is hosted by Substack.

dataitems[]publicationcommentsEnabled
booleannullable

Whether comments are enabled.

dataitems[]publicationnotesEnabled
booleannullable

Whether Notes are enabled.

dataitems[]publicationdefaultCommentSort
stringnullable

The default comment order.

dataitems[]publicationannualDisabled
booleannullable

Whether annual plans are disabled.

dataitems[]publicationmonthlyDisabled
booleannullable

Whether monthly plans are disabled.

dataitems[]publicationpaymentsState
stringnullable

The publication's payments state.

dataitems[]publicationfreeTrialEnabled
booleannullable

Whether a free trial is offered.

dataitems[]publicationpausedUntil
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]publicationemailBannerUrl
stringnullable

The email banner image URL.

dataitems[]publicationcopyright
stringnullable

The copyright line the publication prints.

dataitems[]publicationlogoUrl
stringnullable

The publication's logo URL.

dataitems[]publicationwideLogoUrl
stringnullable

The publication's wide logo URL.

dataitems[]publicationcoverImageUrl
stringnullable

The publication's cover image URL.

dataitems[]publicationfoundingPlanName
stringnullable

The name of the founding-member plan.

dataitems[]publicationhasRecommendations
booleannullable

Whether the publication recommends others.

The benefit lists for each subscription tier.

Benefits for free subscribers.

dataitems[]publicationbenefitsfree[]
stringoptional

Benefits for paid subscribers.

dataitems[]publicationbenefitspaid[]
stringoptional

Benefits for founding members.

dataitems[]publicationbenefitsfounding[]
stringoptional

The publication's main author.

dataitems[]publicationauthorid
integernullable

Numeric user id.

dataitems[]publicationauthorname
stringnullable

The name shown for the author.

dataitems[]publicationauthorhandle
stringnullable

The author's handle.

dataitems[]publicationauthorslug
stringnullable

The author's profile slug.

dataitems[]publicationauthorbio
stringnullable

The author's short biography.

dataitems[]publicationauthorphotoUrl
stringnullable

The author's profile photo URL.

The author's main badge, when there is one.

dataitems[]publicationauthorbadgetype
stringnullable

The kind of badge, such as `bestseller`.

dataitems[]publicationauthorbadgetier
integernullable

The badge tier, when it has one.

dataitems[]publicationauthorbadgehandle
stringnullable

The handle the badge belongs to.

dataitems[]publicationauthorbadgeservice
stringnullable

The service the badge comes from.

dataitems[]publicationauthorbadgeurl
stringnullable

A link for the badge, when it has one.

dataitems[]publicationauthorbadges
objectnullable

The author's reader status fields, when available.

dataitems[]publicationauthorbestsellerTier
integernullable

The author's bestseller tier.

The author's primary publication, when there is one.

dataitems[]publicationauthorprimaryPublicationid
integernullable

Numeric publication id.

dataitems[]publicationauthorprimaryPublicationname
stringnullable

The publication's name.

dataitems[]publicationauthorprimaryPublicationsubdomain
stringnullable

The publication's Substack subdomain.

dataitems[]publicationauthorprimaryPublicationcustomDomain
stringnullable

The publication's custom domain, when it has one.

dataitems[]publicationauthorprimaryPublicationlogoUrl
stringnullable

The publication's logo URL.

Approximate audience figures the publication prints. These are bands, not counts.

dataitems[]publicationaudiencepaidLabel
stringnullable

The band Substack displays for paid subscribers.

dataitems[]publicationaudiencepaidOrderOfMagnitude
integernullable

The order of magnitude behind the paid band.

dataitems[]publicationaudiencetotalLabel
stringnullable

The band Substack displays for all subscribers.

dataitems[]publicationaudiencetotalOrderOfMagnitude
integernullable

The order of magnitude behind the total band.

dataitems[]publicationaudiencefreeLabel
stringnullable

The band Substack displays for free subscribers.

dataitems[]publicationaudiencefreeShort
stringnullable

The short free-subscriber band.

dataitems[]publicationaudiencechatMembersLabel
stringnullable

The band Substack displays for chat members.

People with a byline on the publication.

dataitems[]publicationcontributors[]id
integernullable

Numeric user id.

dataitems[]publicationcontributors[]name
stringnullable

The contributor's name.

dataitems[]publicationcontributors[]handle
stringnullable

The contributor's handle.

dataitems[]publicationcontributors[]role
stringnullable

The contributor's role on the publication.

dataitems[]publicationcontributors[]owner
booleannullable

Whether the contributor owns the publication.

dataitems[]publicationcontributors[]photoUrl
stringnullable

The contributor's photo URL.

dataitems[]publicationcontributors[]bio
stringnullable

The contributor's short biography.

The contributor's badge.

dataitems[]publicationcontributors[]badgetype
stringnullable

The kind of badge, such as `bestseller`.

dataitems[]publicationcontributors[]badgetier
integernullable

The badge tier, when it has one.

dataitems[]publicationcontributors[]badgehandle
stringnullable

The handle the badge belongs to.

dataitems[]publicationcontributors[]badgeservice
stringnullable

The service the badge comes from.

dataitems[]publicationcontributors[]badgeurl
stringnullable

A link for the badge, when it has one.

dataitems[]publicationcontributors[]bestsellerTier
integernullable

The contributor's bestseller tier.

The publication's sections.

dataitems[]publicationsections[]id
integernullable

Numeric section id.

dataitems[]publicationsections[]name
stringnullable

The section's name.

dataitems[]publicationsections[]description
stringnullable

The section's description.

dataitems[]publicationsections[]slug
stringnullable

The section's URL slug.

dataitems[]publicationsections[]isPodcast
booleannullable

Whether the section is a podcast.

dataitems[]publicationsections[]isLive
booleannullable

Whether the section is a live stream.

dataitems[]publicationsections[]isDefaultOn
booleannullable

Whether the section is on by default.

dataitems[]publicationsections[]logoUrl
stringnullable

The section's logo URL.

dataitems[]publicationsections[]coverImageUrl
stringnullable

The section's cover image URL.

dataitems[]publicationsections[]hideFromNavbar
booleannullable

Whether the section is hidden from navigation.

dataitems[]publicationsections[]hidePostsFromPubListings
booleannullable

Whether the section's posts are hidden from publication lists.

Links the publication shows.

dataitems[]publicationlinks[]id
integernullable

Numeric link id.

dataitems[]publicationlinks[]url
string

The link.

dataitems[]publicationlinks[]platform
stringnullable

`apple_podcasts`, `spotify`, `youtube` or another label Substack uses.

dataitems[]publicationlinks[]sectionId
integernullable

The section the link belongs to, when it has one.

The subscription plans the publication offers.

dataitems[]publicationplans[]id
stringnullable

The plan's id.

dataitems[]publicationplans[]nickname
stringnullable

The plan's display name.

dataitems[]publicationplans[]amount
integernullable

Price in the currency's minor unit.

dataitems[]publicationplans[]currency
stringnullable

Currency code for the price.

dataitems[]publicationplans[]interval
stringnullable

`month`, `year` or Substack's own value.

dataitems[]publicationplans[]intervalCount
integernullable

How many intervals one charge covers.

dataitems[]publicationplans[]active
booleannullable

Whether the plan is on sale.

dataitems[]publicationplans[]founding
boolean

Whether this is a founding-member plan.

The publication's podcast, when it has one.

dataitems[]publicationpodcastexists
booleannullable

Whether the publication has a podcast.

dataitems[]publicationpodcasthasFreeEpisodes
booleannullable

Whether free episodes are available.

dataitems[]publicationpodcasthasPaidEpisodes
booleannullable

Whether paid episodes are available.

dataitems[]publicationpodcastartUrl
stringnullable

The podcast artwork URL.

dataitems[]publicationpodcastbyline
stringnullable

The podcast byline.

dataitems[]publicationpodcastdescription
stringnullable

The podcast description.

dataitems[]publicationpodcastfeedUrl
stringnullable

The podcast feed URL.

dataitems[]publicationpodcasttitle
stringnullable

The podcast title.

dataitems[]publicationpodcastpaidEpisodeArtUrl
stringnullable

Artwork for paid episodes.

Matching profiles, when the item is a profile block.

dataitems[]profiles[]id
integer

Numeric user id.

dataitems[]profiles[]name
stringnullable

The reader's display name.

dataitems[]profiles[]handle
stringnullable

The reader's handle.

dataitems[]profiles[]slug
stringnullable

The reader's profile slug.

dataitems[]profiles[]bio
stringnullable

The reader's short biography.

dataitems[]profiles[]photoUrl
stringnullable

The reader's profile photo URL.

dataitems[]profiles[]createdAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]profiles[]isDisabled
booleannullable

Whether the profile is disabled.

dataitems[]profiles[]followerCount
integernullable

The number of followers.

dataitems[]profiles[]subscriberCount
integernullable

The numeric count.

dataitems[]profiles[]subscriberCountLabel
stringnullable

The label Substack displays.

dataitems[]profiles[]roughFreeSubscribers
stringnullable

The free-subscriber band Substack displays.

dataitems[]profiles[]roughFreeSubscribersInt
integernullable

The numeric value behind the free band.

dataitems[]profiles[]roughSubscribers
stringnullable

The subscriber band Substack displays.

dataitems[]profiles[]roughSubscribersInt
integernullable

The numeric value behind the subscriber band.

dataitems[]profiles[]badges
objectnullable

The reader's status fields, when available.

dataitems[]profiles[]bestsellerTier
integernullable

The reader's bestseller tier.

The reader's leaderboard position.

dataitems[]profiles[]leaderboardcategory
stringnullable

The leaderboard category.

dataitems[]profiles[]leaderboardrank
integernullable

The rank in that category.

dataitems[]profiles[]leaderboardranking
stringnullable

`paid`, `free` or Substack's own label.

dataitems[]profiles[]leaderboardpublicationId
integernullable

Numeric publication id.

dataitems[]profiles[]leaderboardpublicationName
stringnullable

The publication's name.

Links the reader shows.

dataitems[]profiles[]links[]id
integernullable

Numeric link id.

dataitems[]profiles[]links[]value
stringnullable

The value the person entered for the link.

dataitems[]profiles[]links[]url
stringnullable

The link's URL.

dataitems[]profiles[]links[]type
stringnullable

The link type, such as `twitter`.

dataitems[]profiles[]links[]label
stringnullable

The label shown for the link.

dataitems[]profiles[]publicationUrl
stringnullable

The reader's publication URL.

dataitems[]profiles[]hasNotes
booleannullable

Whether the reader has Notes.

dataitems[]profiles[]hasGuestPost
booleannullable

Whether the reader has a guest post.

dataitems[]profiles[]hasLikes
booleannullable

Whether the reader has likes.

dataitems[]profiles[]hasPosts
booleannullable

Whether the reader has posts.

dataitems[]profiles[]recommendationCount
integernullable

The number of recommendations.

The reader's primary publication.

dataitems[]profiles[]primaryPublicationid
integer

Numeric publication id.

dataitems[]profiles[]primaryPublicationname
stringnullable

The publication's name.

dataitems[]profiles[]primaryPublicationsubdomain
stringnullable

The publication's Substack subdomain.

dataitems[]profiles[]primaryPublicationcustomDomain
stringnullable

The publication's custom domain, when it has one.

dataitems[]profiles[]primaryPublicationapexDomain
stringnullable

The publication's apex domain, when it has one.

dataitems[]profiles[]primaryPublicationurl
stringnullable

The publication's canonical base URL.

dataitems[]profiles[]primaryPublicationhost
stringnullable

The host its pages are served from.

dataitems[]profiles[]primaryPublicationdescription
stringnullable

The publication's description.

dataitems[]profiles[]primaryPublicationlanguage
stringnullable

The publication's language code.

dataitems[]profiles[]primaryPublicationkind
stringnullable

`newsletter`, `podcast` or Substack's own type.

dataitems[]profiles[]primaryPublicationcreatedAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]profiles[]primaryPublicationfirstPostAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]profiles[]primaryPublicationhasPosts
booleannullable

Whether the publication has posts.

dataitems[]profiles[]primaryPublicationisExplicit
booleannullable

Whether the publication is marked explicit.

dataitems[]profiles[]primaryPublicationisInviteOnly
booleannullable

Whether the publication is invite-only.

dataitems[]profiles[]primaryPublicationisFlagged
booleannullable

Whether the publication is flagged.

dataitems[]profiles[]primaryPublicationnoIndex
booleannullable

Whether search engines are asked not to index it.

dataitems[]profiles[]primaryPublicationisOnSubstack
booleannullable

Whether the publication is hosted by Substack.

dataitems[]profiles[]primaryPublicationcommentsEnabled
booleannullable

Whether comments are enabled.

dataitems[]profiles[]primaryPublicationnotesEnabled
booleannullable

Whether Notes are enabled.

dataitems[]profiles[]primaryPublicationdefaultCommentSort
stringnullable

The default comment order.

dataitems[]profiles[]primaryPublicationannualDisabled
booleannullable

Whether annual plans are disabled.

dataitems[]profiles[]primaryPublicationmonthlyDisabled
booleannullable

Whether monthly plans are disabled.

dataitems[]profiles[]primaryPublicationpaymentsState
stringnullable

The publication's payments state.

dataitems[]profiles[]primaryPublicationfreeTrialEnabled
booleannullable

Whether a free trial is offered.

dataitems[]profiles[]primaryPublicationpausedUntil
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]profiles[]primaryPublicationemailBannerUrl
stringnullable

The email banner image URL.

dataitems[]profiles[]primaryPublicationcopyright
stringnullable

The copyright line the publication prints.

dataitems[]profiles[]primaryPublicationlogoUrl
stringnullable

The publication's logo URL.

dataitems[]profiles[]primaryPublicationwideLogoUrl
stringnullable

The publication's wide logo URL.

dataitems[]profiles[]primaryPublicationcoverImageUrl
stringnullable

The publication's cover image URL.

dataitems[]profiles[]primaryPublicationfoundingPlanName
stringnullable

The name of the founding-member plan.

dataitems[]profiles[]primaryPublicationhasRecommendations
booleannullable

Whether the publication recommends others.

The benefit lists for each subscription tier.

Benefits for free subscribers.

dataitems[]profiles[]primaryPublicationbenefitsfree[]
stringoptional

Benefits for paid subscribers.

dataitems[]profiles[]primaryPublicationbenefitspaid[]
stringoptional

Benefits for founding members.

dataitems[]profiles[]primaryPublicationbenefitsfounding[]
stringoptional

The publication's main author.

dataitems[]profiles[]primaryPublicationauthorid
integernullable

Numeric user id.

dataitems[]profiles[]primaryPublicationauthorname
stringnullable

The name shown for the author.

dataitems[]profiles[]primaryPublicationauthorhandle
stringnullable

The author's handle.

dataitems[]profiles[]primaryPublicationauthorslug
stringnullable

The author's profile slug.

dataitems[]profiles[]primaryPublicationauthorbio
stringnullable

The author's short biography.

dataitems[]profiles[]primaryPublicationauthorphotoUrl
stringnullable

The author's profile photo URL.

The author's main badge, when there is one.

dataitems[]profiles[]primaryPublicationauthorbadgetype
stringnullable

The kind of badge, such as `bestseller`.

dataitems[]profiles[]primaryPublicationauthorbadgetier
integernullable

The badge tier, when it has one.

dataitems[]profiles[]primaryPublicationauthorbadgehandle
stringnullable

The handle the badge belongs to.

dataitems[]profiles[]primaryPublicationauthorbadgeservice
stringnullable

The service the badge comes from.

dataitems[]profiles[]primaryPublicationauthorbadgeurl
stringnullable

A link for the badge, when it has one.

dataitems[]profiles[]primaryPublicationauthorbadges
objectnullable

The author's reader status fields, when available.

dataitems[]profiles[]primaryPublicationauthorbestsellerTier
integernullable

The author's bestseller tier.

The author's primary publication, when there is one.

dataitems[]profiles[]primaryPublicationauthorprimaryPublicationid
integernullable

Numeric publication id.

dataitems[]profiles[]primaryPublicationauthorprimaryPublicationname
stringnullable

The publication's name.

dataitems[]profiles[]primaryPublicationauthorprimaryPublicationsubdomain
stringnullable

The publication's Substack subdomain.

dataitems[]profiles[]primaryPublicationauthorprimaryPublicationcustomDomain
stringnullable

The publication's custom domain, when it has one.

dataitems[]profiles[]primaryPublicationauthorprimaryPublicationlogoUrl
stringnullable

The publication's logo URL.

Approximate audience figures the publication prints. These are bands, not counts.

dataitems[]profiles[]primaryPublicationaudiencepaidLabel
stringnullable

The band Substack displays for paid subscribers.

dataitems[]profiles[]primaryPublicationaudiencepaidOrderOfMagnitude
integernullable

The order of magnitude behind the paid band.

dataitems[]profiles[]primaryPublicationaudiencetotalLabel
stringnullable

The band Substack displays for all subscribers.

dataitems[]profiles[]primaryPublicationaudiencetotalOrderOfMagnitude
integernullable

The order of magnitude behind the total band.

dataitems[]profiles[]primaryPublicationaudiencefreeLabel
stringnullable

The band Substack displays for free subscribers.

dataitems[]profiles[]primaryPublicationaudiencefreeShort
stringnullable

The short free-subscriber band.

dataitems[]profiles[]primaryPublicationaudiencechatMembersLabel
stringnullable

The band Substack displays for chat members.

People with a byline on the publication.

dataitems[]profiles[]primaryPublicationcontributors[]id
integernullable

Numeric user id.

dataitems[]profiles[]primaryPublicationcontributors[]name
stringnullable

The contributor's name.

dataitems[]profiles[]primaryPublicationcontributors[]handle
stringnullable

The contributor's handle.

dataitems[]profiles[]primaryPublicationcontributors[]role
stringnullable

The contributor's role on the publication.

dataitems[]profiles[]primaryPublicationcontributors[]owner
booleannullable

Whether the contributor owns the publication.

dataitems[]profiles[]primaryPublicationcontributors[]photoUrl
stringnullable

The contributor's photo URL.

dataitems[]profiles[]primaryPublicationcontributors[]bio
stringnullable

The contributor's short biography.

The contributor's badge.

dataitems[]profiles[]primaryPublicationcontributors[]badgetype
stringnullable

The kind of badge, such as `bestseller`.

dataitems[]profiles[]primaryPublicationcontributors[]badgetier
integernullable

The badge tier, when it has one.

dataitems[]profiles[]primaryPublicationcontributors[]badgehandle
stringnullable

The handle the badge belongs to.

dataitems[]profiles[]primaryPublicationcontributors[]badgeservice
stringnullable

The service the badge comes from.

dataitems[]profiles[]primaryPublicationcontributors[]badgeurl
stringnullable

A link for the badge, when it has one.

dataitems[]profiles[]primaryPublicationcontributors[]bestsellerTier
integernullable

The contributor's bestseller tier.

The publication's sections.

dataitems[]profiles[]primaryPublicationsections[]id
integernullable

Numeric section id.

dataitems[]profiles[]primaryPublicationsections[]name
stringnullable

The section's name.

dataitems[]profiles[]primaryPublicationsections[]description
stringnullable

The section's description.

dataitems[]profiles[]primaryPublicationsections[]slug
stringnullable

The section's URL slug.

dataitems[]profiles[]primaryPublicationsections[]isPodcast
booleannullable

Whether the section is a podcast.

dataitems[]profiles[]primaryPublicationsections[]isLive
booleannullable

Whether the section is a live stream.

dataitems[]profiles[]primaryPublicationsections[]isDefaultOn
booleannullable

Whether the section is on by default.

dataitems[]profiles[]primaryPublicationsections[]logoUrl
stringnullable

The section's logo URL.

dataitems[]profiles[]primaryPublicationsections[]coverImageUrl
stringnullable

The section's cover image URL.

dataitems[]profiles[]primaryPublicationsections[]hideFromNavbar
booleannullable

Whether the section is hidden from navigation.

dataitems[]profiles[]primaryPublicationsections[]hidePostsFromPubListings
booleannullable

Whether the section's posts are hidden from publication lists.

Links the publication shows.

dataitems[]profiles[]primaryPublicationlinks[]id
integernullable

Numeric link id.

dataitems[]profiles[]primaryPublicationlinks[]url
string

The link.

dataitems[]profiles[]primaryPublicationlinks[]platform
stringnullable

`apple_podcasts`, `spotify`, `youtube` or another label Substack uses.

dataitems[]profiles[]primaryPublicationlinks[]sectionId
integernullable

The section the link belongs to, when it has one.

The subscription plans the publication offers.

dataitems[]profiles[]primaryPublicationplans[]id
stringnullable

The plan's id.

dataitems[]profiles[]primaryPublicationplans[]nickname
stringnullable

The plan's display name.

dataitems[]profiles[]primaryPublicationplans[]amount
integernullable

Price in the currency's minor unit.

dataitems[]profiles[]primaryPublicationplans[]currency
stringnullable

Currency code for the price.

dataitems[]profiles[]primaryPublicationplans[]interval
stringnullable

`month`, `year` or Substack's own value.

dataitems[]profiles[]primaryPublicationplans[]intervalCount
integernullable

How many intervals one charge covers.

dataitems[]profiles[]primaryPublicationplans[]active
booleannullable

Whether the plan is on sale.

dataitems[]profiles[]primaryPublicationplans[]founding
boolean

Whether this is a founding-member plan.

The publication's podcast, when it has one.

dataitems[]profiles[]primaryPublicationpodcastexists
booleannullable

Whether the publication has a podcast.

dataitems[]profiles[]primaryPublicationpodcasthasFreeEpisodes
booleannullable

Whether free episodes are available.

dataitems[]profiles[]primaryPublicationpodcasthasPaidEpisodes
booleannullable

Whether paid episodes are available.

dataitems[]profiles[]primaryPublicationpodcastartUrl
stringnullable

The podcast artwork URL.

dataitems[]profiles[]primaryPublicationpodcastbyline
stringnullable

The podcast byline.

dataitems[]profiles[]primaryPublicationpodcastdescription
stringnullable

The podcast description.

dataitems[]profiles[]primaryPublicationpodcastfeedUrl
stringnullable

The podcast feed URL.

dataitems[]profiles[]primaryPublicationpodcasttitle
stringnullable

The podcast title.

dataitems[]profiles[]primaryPublicationpodcastpaidEpisodeArtUrl
stringnullable

Artwork for paid episodes.

Publications the reader writes for.

dataitems[]profiles[]publications[]role
stringnullable

The person's role on the publication.

dataitems[]profiles[]publications[]public
booleannullable

Whether the role is shown publicly.

dataitems[]profiles[]publications[]isPrimary
booleannullable

Whether this is the person's primary publication.

A Substack publication.

dataitems[]profiles[]publications[]publicationid
integer

Numeric publication id.

dataitems[]profiles[]publications[]publicationname
stringnullable

The publication's name.

dataitems[]profiles[]publications[]publicationsubdomain
stringnullable

The publication's Substack subdomain.

dataitems[]profiles[]publications[]publicationcustomDomain
stringnullable

The publication's custom domain, when it has one.

dataitems[]profiles[]publications[]publicationapexDomain
stringnullable

The publication's apex domain, when it has one.

dataitems[]profiles[]publications[]publicationurl
stringnullable

The publication's canonical base URL.

dataitems[]profiles[]publications[]publicationhost
stringnullable

The host its pages are served from.

dataitems[]profiles[]publications[]publicationdescription
stringnullable

The publication's description.

dataitems[]profiles[]publications[]publicationlanguage
stringnullable

The publication's language code.

dataitems[]profiles[]publications[]publicationkind
stringnullable

`newsletter`, `podcast` or Substack's own type.

dataitems[]profiles[]publications[]publicationcreatedAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]profiles[]publications[]publicationfirstPostAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]profiles[]publications[]publicationhasPosts
booleannullable

Whether the publication has posts.

dataitems[]profiles[]publications[]publicationisExplicit
booleannullable

Whether the publication is marked explicit.

dataitems[]profiles[]publications[]publicationisInviteOnly
booleannullable

Whether the publication is invite-only.

dataitems[]profiles[]publications[]publicationisFlagged
booleannullable

Whether the publication is flagged.

dataitems[]profiles[]publications[]publicationnoIndex
booleannullable

Whether search engines are asked not to index it.

dataitems[]profiles[]publications[]publicationisOnSubstack
booleannullable

Whether the publication is hosted by Substack.

dataitems[]profiles[]publications[]publicationcommentsEnabled
booleannullable

Whether comments are enabled.

dataitems[]profiles[]publications[]publicationnotesEnabled
booleannullable

Whether Notes are enabled.

dataitems[]profiles[]publications[]publicationdefaultCommentSort
stringnullable

The default comment order.

dataitems[]profiles[]publications[]publicationannualDisabled
booleannullable

Whether annual plans are disabled.

dataitems[]profiles[]publications[]publicationmonthlyDisabled
booleannullable

Whether monthly plans are disabled.

dataitems[]profiles[]publications[]publicationpaymentsState
stringnullable

The publication's payments state.

dataitems[]profiles[]publications[]publicationfreeTrialEnabled
booleannullable

Whether a free trial is offered.

dataitems[]profiles[]publications[]publicationpausedUntil
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]profiles[]publications[]publicationemailBannerUrl
stringnullable

The email banner image URL.

dataitems[]profiles[]publications[]publicationcopyright
stringnullable

The copyright line the publication prints.

dataitems[]profiles[]publications[]publicationlogoUrl
stringnullable

The publication's logo URL.

dataitems[]profiles[]publications[]publicationwideLogoUrl
stringnullable

The publication's wide logo URL.

dataitems[]profiles[]publications[]publicationcoverImageUrl
stringnullable

The publication's cover image URL.

dataitems[]profiles[]publications[]publicationfoundingPlanName
stringnullable

The name of the founding-member plan.

dataitems[]profiles[]publications[]publicationhasRecommendations
booleannullable

Whether the publication recommends others.

The benefit lists for each subscription tier.

Benefits for free subscribers.

dataitems[]profiles[]publications[]publicationbenefitsfree[]
stringoptional

Benefits for paid subscribers.

dataitems[]profiles[]publications[]publicationbenefitspaid[]
stringoptional

Benefits for founding members.

dataitems[]profiles[]publications[]publicationbenefitsfounding[]
stringoptional

The publication's main author.

dataitems[]profiles[]publications[]publicationauthorid
integernullable

Numeric user id.

dataitems[]profiles[]publications[]publicationauthorname
stringnullable

The name shown for the author.

dataitems[]profiles[]publications[]publicationauthorhandle
stringnullable

The author's handle.

dataitems[]profiles[]publications[]publicationauthorslug
stringnullable

The author's profile slug.

dataitems[]profiles[]publications[]publicationauthorbio
stringnullable

The author's short biography.

dataitems[]profiles[]publications[]publicationauthorphotoUrl
stringnullable

The author's profile photo URL.

The author's main badge, when there is one.

dataitems[]profiles[]publications[]publicationauthorbadgetype
stringnullable

The kind of badge, such as `bestseller`.

dataitems[]profiles[]publications[]publicationauthorbadgetier
integernullable

The badge tier, when it has one.

dataitems[]profiles[]publications[]publicationauthorbadgehandle
stringnullable

The handle the badge belongs to.

dataitems[]profiles[]publications[]publicationauthorbadgeservice
stringnullable

The service the badge comes from.

dataitems[]profiles[]publications[]publicationauthorbadgeurl
stringnullable

A link for the badge, when it has one.

dataitems[]profiles[]publications[]publicationauthorbadges
objectnullable

The author's reader status fields, when available.

dataitems[]profiles[]publications[]publicationauthorbestsellerTier
integernullable

The author's bestseller tier.

The author's primary publication, when there is one.

dataitems[]profiles[]publications[]publicationauthorprimaryPublicationid
integernullable

Numeric publication id.

dataitems[]profiles[]publications[]publicationauthorprimaryPublicationname
stringnullable

The publication's name.

dataitems[]profiles[]publications[]publicationauthorprimaryPublicationsubdomain
stringnullable

The publication's Substack subdomain.

dataitems[]profiles[]publications[]publicationauthorprimaryPublicationcustomDomain
stringnullable

The publication's custom domain, when it has one.

dataitems[]profiles[]publications[]publicationauthorprimaryPublicationlogoUrl
stringnullable

The publication's logo URL.

Approximate audience figures the publication prints. These are bands, not counts.

dataitems[]profiles[]publications[]publicationaudiencepaidLabel
stringnullable

The band Substack displays for paid subscribers.

dataitems[]profiles[]publications[]publicationaudiencepaidOrderOfMagnitude
integernullable

The order of magnitude behind the paid band.

dataitems[]profiles[]publications[]publicationaudiencetotalLabel
stringnullable

The band Substack displays for all subscribers.

dataitems[]profiles[]publications[]publicationaudiencetotalOrderOfMagnitude
integernullable

The order of magnitude behind the total band.

dataitems[]profiles[]publications[]publicationaudiencefreeLabel
stringnullable

The band Substack displays for free subscribers.

dataitems[]profiles[]publications[]publicationaudiencefreeShort
stringnullable

The short free-subscriber band.

dataitems[]profiles[]publications[]publicationaudiencechatMembersLabel
stringnullable

The band Substack displays for chat members.

People with a byline on the publication.

dataitems[]profiles[]publications[]publicationcontributors[]id
integernullable

Numeric user id.

dataitems[]profiles[]publications[]publicationcontributors[]name
stringnullable

The contributor's name.

dataitems[]profiles[]publications[]publicationcontributors[]handle
stringnullable

The contributor's handle.

dataitems[]profiles[]publications[]publicationcontributors[]role
stringnullable

The contributor's role on the publication.

dataitems[]profiles[]publications[]publicationcontributors[]owner
booleannullable

Whether the contributor owns the publication.

dataitems[]profiles[]publications[]publicationcontributors[]photoUrl
stringnullable

The contributor's photo URL.

dataitems[]profiles[]publications[]publicationcontributors[]bio
stringnullable

The contributor's short biography.

The contributor's badge.

dataitems[]profiles[]publications[]publicationcontributors[]badgetype
stringnullable

The kind of badge, such as `bestseller`.

dataitems[]profiles[]publications[]publicationcontributors[]badgetier
integernullable

The badge tier, when it has one.

dataitems[]profiles[]publications[]publicationcontributors[]badgehandle
stringnullable

The handle the badge belongs to.

dataitems[]profiles[]publications[]publicationcontributors[]badgeservice
stringnullable

The service the badge comes from.

dataitems[]profiles[]publications[]publicationcontributors[]badgeurl
stringnullable

A link for the badge, when it has one.

dataitems[]profiles[]publications[]publicationcontributors[]bestsellerTier
integernullable

The contributor's bestseller tier.

The publication's sections.

dataitems[]profiles[]publications[]publicationsections[]id
integernullable

Numeric section id.

dataitems[]profiles[]publications[]publicationsections[]name
stringnullable

The section's name.

dataitems[]profiles[]publications[]publicationsections[]description
stringnullable

The section's description.

dataitems[]profiles[]publications[]publicationsections[]slug
stringnullable

The section's URL slug.

dataitems[]profiles[]publications[]publicationsections[]isPodcast
booleannullable

Whether the section is a podcast.

dataitems[]profiles[]publications[]publicationsections[]isLive
booleannullable

Whether the section is a live stream.

dataitems[]profiles[]publications[]publicationsections[]isDefaultOn
booleannullable

Whether the section is on by default.

dataitems[]profiles[]publications[]publicationsections[]logoUrl
stringnullable

The section's logo URL.

dataitems[]profiles[]publications[]publicationsections[]coverImageUrl
stringnullable

The section's cover image URL.

dataitems[]profiles[]publications[]publicationsections[]hideFromNavbar
booleannullable

Whether the section is hidden from navigation.

dataitems[]profiles[]publications[]publicationsections[]hidePostsFromPubListings
booleannullable

Whether the section's posts are hidden from publication lists.

Links the publication shows.

dataitems[]profiles[]publications[]publicationlinks[]id
integernullable

Numeric link id.

dataitems[]profiles[]publications[]publicationlinks[]url
string

The link.

dataitems[]profiles[]publications[]publicationlinks[]platform
stringnullable

`apple_podcasts`, `spotify`, `youtube` or another label Substack uses.

dataitems[]profiles[]publications[]publicationlinks[]sectionId
integernullable

The section the link belongs to, when it has one.

The subscription plans the publication offers.

dataitems[]profiles[]publications[]publicationplans[]id
stringnullable

The plan's id.

dataitems[]profiles[]publications[]publicationplans[]nickname
stringnullable

The plan's display name.

dataitems[]profiles[]publications[]publicationplans[]amount
integernullable

Price in the currency's minor unit.

dataitems[]profiles[]publications[]publicationplans[]currency
stringnullable

Currency code for the price.

dataitems[]profiles[]publications[]publicationplans[]interval
stringnullable

`month`, `year` or Substack's own value.

dataitems[]profiles[]publications[]publicationplans[]intervalCount
integernullable

How many intervals one charge covers.

dataitems[]profiles[]publications[]publicationplans[]active
booleannullable

Whether the plan is on sale.

dataitems[]profiles[]publications[]publicationplans[]founding
boolean

Whether this is a founding-member plan.

The publication's podcast, when it has one.

dataitems[]profiles[]publications[]publicationpodcastexists
booleannullable

Whether the publication has a podcast.

dataitems[]profiles[]publications[]publicationpodcasthasFreeEpisodes
booleannullable

Whether free episodes are available.

dataitems[]profiles[]publications[]publicationpodcasthasPaidEpisodes
booleannullable

Whether paid episodes are available.

dataitems[]profiles[]publications[]publicationpodcastartUrl
stringnullable

The podcast artwork URL.

dataitems[]profiles[]publications[]publicationpodcastbyline
stringnullable

The podcast byline.

dataitems[]profiles[]publications[]publicationpodcastdescription
stringnullable

The podcast description.

dataitems[]profiles[]publications[]publicationpodcastfeedUrl
stringnullable

The podcast feed URL.

dataitems[]profiles[]publications[]publicationpodcasttitle
stringnullable

The podcast title.

dataitems[]profiles[]publications[]publicationpodcastpaidEpisodeArtUrl
stringnullable

Artwork for paid episodes.

Publications the reader shows publicly.

dataitems[]profiles[]subscriptions[]id
integernullable

Numeric subscription id.

dataitems[]profiles[]subscriptions[]visibility
stringnullable

Who can see the subscription.

dataitems[]profiles[]subscriptions[]membershipState
stringnullable

The person's membership state.

dataitems[]profiles[]subscriptions[]type
stringnullable

The subscription type.

dataitems[]profiles[]subscriptions[]isFounding
booleannullable

Whether this is a founding membership.

A Substack publication.

dataitems[]profiles[]subscriptions[]publicationid
integer

Numeric publication id.

dataitems[]profiles[]subscriptions[]publicationname
stringnullable

The publication's name.

dataitems[]profiles[]subscriptions[]publicationsubdomain
stringnullable

The publication's Substack subdomain.

dataitems[]profiles[]subscriptions[]publicationcustomDomain
stringnullable

The publication's custom domain, when it has one.

dataitems[]profiles[]subscriptions[]publicationapexDomain
stringnullable

The publication's apex domain, when it has one.

dataitems[]profiles[]subscriptions[]publicationurl
stringnullable

The publication's canonical base URL.

dataitems[]profiles[]subscriptions[]publicationhost
stringnullable

The host its pages are served from.

dataitems[]profiles[]subscriptions[]publicationdescription
stringnullable

The publication's description.

dataitems[]profiles[]subscriptions[]publicationlanguage
stringnullable

The publication's language code.

dataitems[]profiles[]subscriptions[]publicationkind
stringnullable

`newsletter`, `podcast` or Substack's own type.

dataitems[]profiles[]subscriptions[]publicationcreatedAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]profiles[]subscriptions[]publicationfirstPostAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]profiles[]subscriptions[]publicationhasPosts
booleannullable

Whether the publication has posts.

dataitems[]profiles[]subscriptions[]publicationisExplicit
booleannullable

Whether the publication is marked explicit.

dataitems[]profiles[]subscriptions[]publicationisInviteOnly
booleannullable

Whether the publication is invite-only.

dataitems[]profiles[]subscriptions[]publicationisFlagged
booleannullable

Whether the publication is flagged.

dataitems[]profiles[]subscriptions[]publicationnoIndex
booleannullable

Whether search engines are asked not to index it.

dataitems[]profiles[]subscriptions[]publicationisOnSubstack
booleannullable

Whether the publication is hosted by Substack.

dataitems[]profiles[]subscriptions[]publicationcommentsEnabled
booleannullable

Whether comments are enabled.

dataitems[]profiles[]subscriptions[]publicationnotesEnabled
booleannullable

Whether Notes are enabled.

dataitems[]profiles[]subscriptions[]publicationdefaultCommentSort
stringnullable

The default comment order.

dataitems[]profiles[]subscriptions[]publicationannualDisabled
booleannullable

Whether annual plans are disabled.

dataitems[]profiles[]subscriptions[]publicationmonthlyDisabled
booleannullable

Whether monthly plans are disabled.

dataitems[]profiles[]subscriptions[]publicationpaymentsState
stringnullable

The publication's payments state.

dataitems[]profiles[]subscriptions[]publicationfreeTrialEnabled
booleannullable

Whether a free trial is offered.

dataitems[]profiles[]subscriptions[]publicationpausedUntil
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]profiles[]subscriptions[]publicationemailBannerUrl
stringnullable

The email banner image URL.

dataitems[]profiles[]subscriptions[]publicationcopyright
stringnullable

The copyright line the publication prints.

dataitems[]profiles[]subscriptions[]publicationlogoUrl
stringnullable

The publication's logo URL.

dataitems[]profiles[]subscriptions[]publicationwideLogoUrl
stringnullable

The publication's wide logo URL.

dataitems[]profiles[]subscriptions[]publicationcoverImageUrl
stringnullable

The publication's cover image URL.

dataitems[]profiles[]subscriptions[]publicationfoundingPlanName
stringnullable

The name of the founding-member plan.

dataitems[]profiles[]subscriptions[]publicationhasRecommendations
booleannullable

Whether the publication recommends others.

The benefit lists for each subscription tier.

Benefits for free subscribers.

dataitems[]profiles[]subscriptions[]publicationbenefitsfree[]
stringoptional

Benefits for paid subscribers.

dataitems[]profiles[]subscriptions[]publicationbenefitspaid[]
stringoptional

Benefits for founding members.

dataitems[]profiles[]subscriptions[]publicationbenefitsfounding[]
stringoptional

The publication's main author.

dataitems[]profiles[]subscriptions[]publicationauthorid
integernullable

Numeric user id.

dataitems[]profiles[]subscriptions[]publicationauthorname
stringnullable

The name shown for the author.

dataitems[]profiles[]subscriptions[]publicationauthorhandle
stringnullable

The author's handle.

dataitems[]profiles[]subscriptions[]publicationauthorslug
stringnullable

The author's profile slug.

dataitems[]profiles[]subscriptions[]publicationauthorbio
stringnullable

The author's short biography.

dataitems[]profiles[]subscriptions[]publicationauthorphotoUrl
stringnullable

The author's profile photo URL.

The author's main badge, when there is one.

dataitems[]profiles[]subscriptions[]publicationauthorbadgetype
stringnullable

The kind of badge, such as `bestseller`.

dataitems[]profiles[]subscriptions[]publicationauthorbadgetier
integernullable

The badge tier, when it has one.

dataitems[]profiles[]subscriptions[]publicationauthorbadgehandle
stringnullable

The handle the badge belongs to.

dataitems[]profiles[]subscriptions[]publicationauthorbadgeservice
stringnullable

The service the badge comes from.

dataitems[]profiles[]subscriptions[]publicationauthorbadgeurl
stringnullable

A link for the badge, when it has one.

dataitems[]profiles[]subscriptions[]publicationauthorbadges
objectnullable

The author's reader status fields, when available.

dataitems[]profiles[]subscriptions[]publicationauthorbestsellerTier
integernullable

The author's bestseller tier.

The author's primary publication, when there is one.

dataitems[]profiles[]subscriptions[]publicationauthorprimaryPublicationid
integernullable

Numeric publication id.

dataitems[]profiles[]subscriptions[]publicationauthorprimaryPublicationname
stringnullable

The publication's name.

dataitems[]profiles[]subscriptions[]publicationauthorprimaryPublicationsubdomain
stringnullable

The publication's Substack subdomain.

dataitems[]profiles[]subscriptions[]publicationauthorprimaryPublicationcustomDomain
stringnullable

The publication's custom domain, when it has one.

dataitems[]profiles[]subscriptions[]publicationauthorprimaryPublicationlogoUrl
stringnullable

The publication's logo URL.

Approximate audience figures the publication prints. These are bands, not counts.

dataitems[]profiles[]subscriptions[]publicationaudiencepaidLabel
stringnullable

The band Substack displays for paid subscribers.

dataitems[]profiles[]subscriptions[]publicationaudiencepaidOrderOfMagnitude
integernullable

The order of magnitude behind the paid band.

dataitems[]profiles[]subscriptions[]publicationaudiencetotalLabel
stringnullable

The band Substack displays for all subscribers.

dataitems[]profiles[]subscriptions[]publicationaudiencetotalOrderOfMagnitude
integernullable

The order of magnitude behind the total band.

dataitems[]profiles[]subscriptions[]publicationaudiencefreeLabel
stringnullable

The band Substack displays for free subscribers.

dataitems[]profiles[]subscriptions[]publicationaudiencefreeShort
stringnullable

The short free-subscriber band.

dataitems[]profiles[]subscriptions[]publicationaudiencechatMembersLabel
stringnullable

The band Substack displays for chat members.

People with a byline on the publication.

dataitems[]profiles[]subscriptions[]publicationcontributors[]id
integernullable

Numeric user id.

dataitems[]profiles[]subscriptions[]publicationcontributors[]name
stringnullable

The contributor's name.

dataitems[]profiles[]subscriptions[]publicationcontributors[]handle
stringnullable

The contributor's handle.

dataitems[]profiles[]subscriptions[]publicationcontributors[]role
stringnullable

The contributor's role on the publication.

dataitems[]profiles[]subscriptions[]publicationcontributors[]owner
booleannullable

Whether the contributor owns the publication.

dataitems[]profiles[]subscriptions[]publicationcontributors[]photoUrl
stringnullable

The contributor's photo URL.

dataitems[]profiles[]subscriptions[]publicationcontributors[]bio
stringnullable

The contributor's short biography.

The contributor's badge.

dataitems[]profiles[]subscriptions[]publicationcontributors[]badgetype
stringnullable

The kind of badge, such as `bestseller`.

dataitems[]profiles[]subscriptions[]publicationcontributors[]badgetier
integernullable

The badge tier, when it has one.

dataitems[]profiles[]subscriptions[]publicationcontributors[]badgehandle
stringnullable

The handle the badge belongs to.

dataitems[]profiles[]subscriptions[]publicationcontributors[]badgeservice
stringnullable

The service the badge comes from.

dataitems[]profiles[]subscriptions[]publicationcontributors[]badgeurl
stringnullable

A link for the badge, when it has one.

dataitems[]profiles[]subscriptions[]publicationcontributors[]bestsellerTier
integernullable

The contributor's bestseller tier.

The publication's sections.

dataitems[]profiles[]subscriptions[]publicationsections[]id
integernullable

Numeric section id.

dataitems[]profiles[]subscriptions[]publicationsections[]name
stringnullable

The section's name.

dataitems[]profiles[]subscriptions[]publicationsections[]description
stringnullable

The section's description.

dataitems[]profiles[]subscriptions[]publicationsections[]slug
stringnullable

The section's URL slug.

dataitems[]profiles[]subscriptions[]publicationsections[]isPodcast
booleannullable

Whether the section is a podcast.

dataitems[]profiles[]subscriptions[]publicationsections[]isLive
booleannullable

Whether the section is a live stream.

dataitems[]profiles[]subscriptions[]publicationsections[]isDefaultOn
booleannullable

Whether the section is on by default.

dataitems[]profiles[]subscriptions[]publicationsections[]logoUrl
stringnullable

The section's logo URL.

dataitems[]profiles[]subscriptions[]publicationsections[]coverImageUrl
stringnullable

The section's cover image URL.

dataitems[]profiles[]subscriptions[]publicationsections[]hideFromNavbar
booleannullable

Whether the section is hidden from navigation.

dataitems[]profiles[]subscriptions[]publicationsections[]hidePostsFromPubListings
booleannullable

Whether the section's posts are hidden from publication lists.

Links the publication shows.

dataitems[]profiles[]subscriptions[]publicationlinks[]id
integernullable

Numeric link id.

dataitems[]profiles[]subscriptions[]publicationlinks[]url
string

The link.

dataitems[]profiles[]subscriptions[]publicationlinks[]platform
stringnullable

`apple_podcasts`, `spotify`, `youtube` or another label Substack uses.

dataitems[]profiles[]subscriptions[]publicationlinks[]sectionId
integernullable

The section the link belongs to, when it has one.

The subscription plans the publication offers.

dataitems[]profiles[]subscriptions[]publicationplans[]id
stringnullable

The plan's id.

dataitems[]profiles[]subscriptions[]publicationplans[]nickname
stringnullable

The plan's display name.

dataitems[]profiles[]subscriptions[]publicationplans[]amount
integernullable

Price in the currency's minor unit.

dataitems[]profiles[]subscriptions[]publicationplans[]currency
stringnullable

Currency code for the price.

dataitems[]profiles[]subscriptions[]publicationplans[]interval
stringnullable

`month`, `year` or Substack's own value.

dataitems[]profiles[]subscriptions[]publicationplans[]intervalCount
integernullable

How many intervals one charge covers.

dataitems[]profiles[]subscriptions[]publicationplans[]active
booleannullable

Whether the plan is on sale.

dataitems[]profiles[]subscriptions[]publicationplans[]founding
boolean

Whether this is a founding-member plan.

The publication's podcast, when it has one.

dataitems[]profiles[]subscriptions[]publicationpodcastexists
booleannullable

Whether the publication has a podcast.

dataitems[]profiles[]subscriptions[]publicationpodcasthasFreeEpisodes
booleannullable

Whether free episodes are available.

dataitems[]profiles[]subscriptions[]publicationpodcasthasPaidEpisodes
booleannullable

Whether paid episodes are available.

dataitems[]profiles[]subscriptions[]publicationpodcastartUrl
stringnullable

The podcast artwork URL.

dataitems[]profiles[]subscriptions[]publicationpodcastbyline
stringnullable

The podcast byline.

dataitems[]profiles[]subscriptions[]publicationpodcastdescription
stringnullable

The podcast description.

dataitems[]profiles[]subscriptions[]publicationpodcastfeedUrl
stringnullable

The podcast feed URL.

dataitems[]profiles[]subscriptions[]publicationpodcasttitle
stringnullable

The podcast title.

dataitems[]profiles[]subscriptions[]publicationpodcastpaidEpisodeArtUrl
stringnullable

Artwork for paid episodes.

dataitems[]profiles[]subscriptionCount
integernullable

The number of public subscriptions.

dataitems[]profiles[]subscriptionsTruncated
booleannullable

True when Substack cut the subscription list.

dataitems[]createdAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

Parent notes, when the item is a reply.

dataitems[]parentComments[]id
integer

Numeric note id.

dataitems[]parentComments[]body
stringnullable

The note's plain text.

dataitems[]parentComments[]bodyJson
objectnullable

The note's rich text document, when there is one.

dataitems[]parentComments[]createdAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

dataitems[]parentComments[]editedAt
stringnullable

ISO 8601 timestamp, or null when Substack does not publish one.

The note's author.

dataitems[]parentComments[]authorid
integernullable

Numeric user id.

dataitems[]parentComments[]authorname
stringnullable

The name shown for the author.

dataitems[]parentComments[]authorhandle
stringnullable

The author's handle.

dataitems[]parentComments[]authorslug
stringnullable

The author's profile slug.

dataitems[]parentComments[]authorbio
stringnullable

The author's short biography.

dataitems[]parentComments[]authorphotoUrl
stringnullable

The author's profile photo URL.

The author's main badge, when there is one.

dataitems[]parentComments[]authorbadgetype
stringnullable

The kind of badge, such as `bestseller`.

dataitems[]parentComments[]authorbadgetier
integernullable

The badge tier, when it has one.

dataitems[]parentComments[]authorbadgehandle
stringnullable

The handle the badge belongs to.

dataitems[]parentComments[]authorbadgeservice
stringnullable

The service the badge comes from.

dataitems[]parentComments[]authorbadgeurl
stringnullable

A link for the badge, when it has one.

dataitems[]parentComments[]authorbadges
objectnullable

The author's reader status fields, when available.

dataitems[]parentComments[]authorbestsellerTier
integernullable

The author's bestseller tier.

The author's primary publication, when there is one.

dataitems[]parentComments[]authorprimaryPublicationid
integernullable

Numeric publication id.

dataitems[]parentComments[]authorprimaryPublicationname
stringnullable

The publication's name.

dataitems[]parentComments[]authorprimaryPublicationsubdomain
stringnullable

The publication's Substack subdomain.

dataitems[]parentComments[]authorprimaryPublicationcustomDomain
stringnullable

The publication's custom domain, when it has one.

dataitems[]parentComments[]authorprimaryPublicationlogoUrl
stringnullable

The publication's logo URL.

dataitems[]parentComments[]reactionCount
integernullable

The number of reactions.

dataitems[]parentComments[]reactions
object

Emoji to reaction count.

dataitems[]parentComments[]restackCount
integernullable

The number of restacks.

dataitems[]parentComments[]replyCount
integernullable

The number of replies.

dataitems[]parentComments[]language
stringnullable

The note's language code.

dataitems[]parentComments[]isAiGenerated
booleannullable

Substack's own flag.

dataitems[]parentComments[]translation
objectnullable

A translation of the note, when there is one.

dataitems[]parentComments[]replyPermission
stringnullable

Who may reply to the note.

dataitems[]parentComments[]ancestorPath
stringnullable

The note's position in a thread.

Images, links, posts or polls attached to the note.

dataitems[]parentComments[]attachments[]id
stringnullable

The attachment's id.

dataitems[]parentComments[]attachments[]type
stringnullable

`image`, `link`, `post`, `poll` or `missing`.

dataitems[]parentComments[]attachments[]imageUrl
stringnullable

The image URL, for an image attachment.

dataitems[]parentComments[]attachments[]imageWidth
integernullable

The image width in pixels.

dataitems[]parentComments[]attachments[]imageHeight
integernullable

The image height in pixels.

dataitems[]parentComments[]attachments[]explicit
booleannullable

Whether the attachment is explicit.

Preview metadata for a link attachment.

dataitems[]parentComments[]attachments[]linkurl
stringnullable

The link's URL.

dataitems[]parentComments[]attachments[]linkhost
stringnullable

The link's host.

dataitems[]parentComments[]attachments[]linktitle
stringnullable

The link's title.

dataitems[]parentComments[]attachments[]linkdescription
stringnullable

The link's description.

dataitems[]parentComments[]attachments[]linkimage
stringnullable

The link's preview image URL.

dataitems[]parentComments[]attachments[]linkoriginalImage
stringnullable

The link's original image URL.

dataitems[]parentComments[]attachments[]postId
integernullable

The attached post's id.

dataitems[]parentComments[]attachments[]publicationId
integernullable

The attached publication's id.

dataitems[]parentComments[]attachments[]reason
stringnullable

Why a missing attachment was removed.

Pagination state for the current page.

datapagehasMore
boolean

Whether another page is available.

datapagenextCursor
stringnullable

Cursor to pass in the next request when more pages exist; null on the last page.

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

Code example

curl "https://api.socialfetch.dev/v1/substack/search?query=climate" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Substack top search.