developer.workday.com APIdeveloper.workday.com ↗
Access Workday's full developer docs navigation tree (1200+ pages), retrieve individual guides in Markdown, and search documentation topics via 4 endpoints.
No input parameters required.
curl -X GET 'https://api.parse.bot/scraper/b2cd46f9-4aac-4f96-9594-256329e52c1b/get_documentation_tree' \ -H 'X-API-Key: $PARSE_API_KEY'
Get the complete documentation navigation tree as a flat list of all pages with their titles, URLs, and slugs. Returns approximately 1200+ documentation page entries covering Integration Apps, Extend Apps, Workday APIs, and Developer Copilot.
No input parameters required.
{
"type": "object",
"fields": {
"pages": "array of objects with title, url, and slug",
"total": "integer"
},
"sample": {
"pages": [
{
"url": "/wcp_docs/relnotes_dl.html",
"slug": "relnotes_dl",
"title": "Documentation Release Notes"
},
{
"url": "/wcp_docs/GUID-1293c9bb-ea02-48cd-a523-254b5060b3a6-enHYPHENus.html",
"slug": "GUID-1293c9bb-ea02-48cd-a523-254b5060b3a6-enHYPHENus",
"title": "Getting Started with Integration Apps"
}
],
"total": 1257
}
}About the developer.workday.com API
This API exposes four endpoints covering Workday's developer documentation portal, giving programmatic access to a navigation tree of 1200+ pages, full Markdown content for individual docs, title-based search, and the curated homepage sections. The get_documentation_tree endpoint returns every page entry with its title, URL, and slug, while get_doc_page retrieves the complete content and metadata — including categories and keywords — for any single page identified by its slug.
Documentation Tree and Page Content
get_documentation_tree returns a flat list of all documentation pages across Workday's developer portal, covering Integration Apps, Extend Apps, Workday APIs, and Developer Copilot. Each entry in the pages array includes a title, url, and slug, with the total field reporting the full count (typically 1200+). Once you have a slug, pass it to get_doc_page to retrieve the full page: the response includes title, layout, content (the page body in Markdown), and metadata arrays for category and keywords. Slugs follow formats like dlx1529688880052 or GUID-style strings such as GUID-1293c9bb-ea02-48cd-a523-254b5060b3a6-enHYPHENus.
Search and Homepage Sections
search_documentation accepts a required query string and performs a case-insensitive substring match against page titles across the full documentation tree. An optional limit parameter caps the number of results returned. Each result in the results array mirrors the tree format: title, url, and slug. The total_results field reflects how many titles matched.
get_doc_home requires no inputs and returns the homepage configuration as an array of sections, each with a title, description, and nested link_groups. The three sections — Get Started, Apps, and Extend Services — surface curated entry points into the documentation and are useful for building navigation UIs or orientation tools on top of the Workday developer portal.
- Build an internal search tool that indexes all 1200+ Workday doc pages using titles and slugs from
get_documentation_tree - Sync Workday API reference content into a private knowledge base by fetching Markdown from
get_doc_pagefor each slug - Surface contextually relevant documentation links in a developer IDE extension using
search_documentationwith keyword queries - Generate an onboarding guide by pulling the 'Get Started' section links from
get_doc_home - Create a documentation diff tool that tracks changes to specific pages over time by storing
contentfields fromget_doc_page - Classify and tag Workday docs by topic using the
categoryandkeywordsmetadata returned fromget_doc_page
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 250 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does Workday have an official developer API?+
What does `search_documentation` match against, and can I search by content body?+
search_documentation matches the query string against page titles only, using a case-insensitive substring comparison. Full-text search across page body content is not currently covered. The API returns titles, URLs, and slugs for matching pages. You can fork it on Parse and revise to add content-body search using data from get_doc_page.Does `get_doc_page` return versioned or historical documentation?+
Can I retrieve documentation for a specific Workday product area only?+
get_documentation_tree endpoint returns all pages as a flat list without server-side filtering by product area such as Integration Apps or Workday APIs. You can filter client-side using the category metadata returned by get_doc_page, but endpoint-level filtering by product area is not currently supported. You can fork it on Parse and revise to add a category filter parameter.What slug formats does `get_doc_page` accept?+
dlx1529688880052 and GUID-style strings like GUID-1293c9bb-ea02-48cd-a523-254b5060b3a6-enHYPHENus. Both formats are returned in the slug field from get_documentation_tree and search_documentation results and can be passed directly to get_doc_page.