Skip to main content
GET
/
v1
/
publications
/
slug
/
{slug}
Get publication by slug
import { ParagraphAPI } from "@paragraph_xyz/sdk"

const api = new ParagraphAPI()
const publication = await api.getPublicationBySlug("blog")
{
  "id": "<string>",
  "name": "<string>",
  "ownerUserId": "<string>",
  "slug": "<string>",
  "customDomain": "<string>",
  "summary": "<string>",
  "logoUrl": "<string>"
}

Path Parameters

​
slug
string
required

URL-friendly identifier of the publication

Required string length: 1 - 256

Response

Publication details retrieved successfully

​
id
string
required

Unique identifier for the publication

​
name
string
required

Display name of the publication

​
ownerUserId
string
required

ID of the user who owns this publication

​
slug
string
required

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

Required string length: 1 - 256
​
customDomain
string<uri>

Custom domain configured for this publication

​
summary
string

Brief description of the publication (max 500 characters)

Maximum length: 500
​
logoUrl
string<uri>

URL to the publication's logo image

⌘I