/zenn/publications

POST /api/zenn/publications

Price: 1 credit

Get Zenn Publication

How to use it

Get a Zenn publication - a company or team tech blog - by name or URL. Returns the description, avatar, cover, follower count, Pro status, the custom navigation links and promo banners it renders, and the curated article lists it groups its posts into. Use zenn/publications/articles for the article feed.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• publication string required — Publication name or its URL (examples: "cybozu_frontend", "https://zenn.dev/p/cybozu_frontend")

Response

• @type string (default: "ZennPublication")
• id integer required
• alias string required
• name string nullable
• description string nullable
• description_html string nullable
• image string nullable
• cover string nullable
• url string nullable
• is_pro boolean (default: false)
• has_avatar boolean (default: false)
• follower_count integer nullable
• award_count integer nullable
• sponsor_count integer nullable
• github_url string nullable
• twitter_url string nullable
• analytics_id string nullable
• is_article_comment_open boolean (default: false)
• is_support_open boolean (default: false)
• has_recent_article_lists boolean (default: false)
• fixed_sentences_html string nullable
• navigations array (default: [])
  • @type string (default: "ZennNavigation")
  • id integer required
  • label string nullable
  • url string nullable
  • position integer nullable
• banners array (default: [])
  • @type string (default: "ZennBanner")
  • id integer required
  • banner_title string nullable
  • image string nullable
  • url string nullable
  • is_published boolean (default: false)
• article_lists array (default: [])
  • @type string (default: "ZennArticleList")
  • alias string required
  • name string nullable
  • description string nullable
  • emoji string nullable
  • image string nullable
  • article_count integer nullable
  • article_order_type string nullable
  • priority integer nullable
  • is_published boolean (default: false)
  • created_at integer nullable
  • updated_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Publication not found. Verify the publication name. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.