PAparagraph-xyz
me

Get authenticated publication

Changed on

Returns the publication associated with the API key used in the request. Useful for verifying your API key and retrieving your publication details.

get/v1/me

Request

  • Base URL
    https://public.api.paragraph.com/api
  • URL
    https://public.api.paragraph.com/api/v1/me
  • Auth
    HTTP bearer

Response

Authenticated publication details retrieved successfully

idstring required

Unique identifier for the publication

namestring required

Display name of the publication

ownerUserIdstring required

ID of the user who owns this publication

slugstring required

URL-friendly identifier for the publication; accessible at paragraph.com/@[slug]

customDomainstring uri

Custom domain configured for this publication

summarystring

Brief description of the publication (max 500 characters)

logoUrlstring uri

URL to the publication's logo image

postListType'feed' | 'grid' | 'full-post'

Homepage layout. 'feed' is a single-column list of cards, 'grid' is a 3-column grid, 'full-post' shows full posts in a single column.

themeColor'default' | 'orange-500' | 'rose-600' | 'pink-500' | 'fuchsia-600' | 'purple-600' | 'violet-600' | 'indigo-600' | 'blue-600' | 'sky-600' | 'cyan-600' | 'teal-600' | 'emerald-600' | 'green-600' | 'lime-600' | 'yellow-700' | 'amber-600' | 'orange-600' | 'stone-800' | 'rose-900' | 'indigo-950' | 'teal-950' | 'lime-950' | 'orange-950'

Theme accent color for the publication

headerFont'default' | 'serif' | 'mono'

Font family used for headers

bodyFont'default' | 'serif' | 'mono'

Font family used for body text

showMostPopularboolean

Whether the 'most popular posts' widget is shown

hideStatsboolean

Whether to hide stats like subscriber count, post count, and collects

featuredPoststring

Featured post selector. Use 'latest' for the most recent post, 'popular' for the most-viewed post, 'disabled' to hide the featured slot, or the ID of a specific post in this publication.

enableTableOfContentsboolean

Whether the table of contents is enabled on posts

enableSubscribePopupboolean

Whether to show the subscribe popup to first-time visitors arriving from external links

enableSubscribeScrollboolean

Whether to show the subscribe popup when first-time visitors scroll a post

pinnedPostIdsstring[]

Ordered list of post IDs pinned to the top of the publication's homepage. Pinned posts render in their own section above the regular feed.

plan'free' | 'starter' | 'growth' | 'scale'

Subscription plan of the publication. Only returned on /v1/me.

Changes

  • 0b69669d5430Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property / from the response with the status

  • f76f6f333ba8Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status