Documentation
Sign inGet started

Read a documentation page

GET
/v1/docs/pages
curl -X GET "https://us1.platform.bird.com/v1/docs/pages" \
  -H "Authorization: Bearer $TOKEN"
Return the full Markdown content of a single Bird documentation page, identified by its slug.
Parameter Kueri
slug
string
Slug of the page to read, as returned in the slug field of a docs_search result (e.g. guides/email/contacts). Use index for the documentation landing page.
locale
string
Documentation locale to read, as a language-region code such as en-us. Defaults to en-us when omitted or unavailable.
Payload Respons
slug
string
wajib
Slug of the page, echoing the requested slug.
locale
string
wajib
Documentation locale the page was drawn from.
url
string
wajib
Absolute URL of the page, suitable to cite as the source of an answer.
markdown
string
wajib
The page's full content as Markdown.