Citrix APIdocs.citrix.com ↗
Search Citrix product documentation via API. Returns ranked results with titles, URLs, snippets, product names, versions, and facets for filtering.
What is the Citrix API?
The Citrix Docs API exposes a single search_docs endpoint that runs full-text queries across Citrix's entire product documentation library, returning up to 50 ranked results per page with 7 structured fields per result: title, URL, snippet, product name, date, file type, and relevance ranking. Results can be narrowed by product, version, and file type using facet values that the API itself returns, making it self-describing for iterative filtering workflows.
curl -X GET 'https://api.parse.bot/scraper/bb2632d3-f773-45ff-a010-007e54bd450f/search_docs?limit=5&query=virtual+apps&offset=0&product=Citrix+Virtual+Apps+and+Desktops&version=Current+Release&file_type=HTML' \ -H 'X-API-Key: $PARSE_API_KEY'
Typed, relational, agent-ready
A generated client with real types, enums, and the links between objects — the structure a flat JSON response can't carry. Autocompletes in your editor and reads cleanly to coding agents.
- Fully typed · autocompletes
- Objects link to objects
- Typed errors & pagination
Typed Python client. Set up the SDK in your uv project, then pull this API’s typed client:
uv add parse-sdk uv run parse init uv run parse add --marketplace docs-citrix-com-api
uv run parse add --marketplace pulls a pinned snapshot of this canonical API — it won’t change underneath you. To customize it, subscribe and swap to your own copy.
"""Walkthrough: CitrixDocs SDK — bounded, re-runnable; every call capped."""
from parse_apis.Citrix_Docs_API import CitrixDocs, ParseError
client = CitrixDocs()
# Search documentation for a topic, capped at 3 results.
for doc in client.documents.search(query="load balancing", limit=3):
print(doc.title, doc.url, doc.product)
# Filtered search: narrow to a specific product.
result = client.documents.search(query="session recording", product="Citrix DaaS", limit=1).first()
if result:
print(result.title, result.snippet[:80])
# Error handling: wrap a call that may fail upstream.
try:
for doc in client.documents.search(query="virtual apps", file_type="HTML", limit=2):
print(doc.title, doc.date)
except ParseError as e:
print(f"search failed: {e.code}")
print("exercised: documents.search")
Full-text search across Citrix product documentation. Returns ranked results with title, URL, snippet, product name, date, and file type. Supports filtering by product, version, and file type via facet values returned in each response. Pagination is offset-based: advance `offset` by `limit` to fetch subsequent pages.
| Param | Type | Description |
|---|---|---|
| limit | integer | Maximum number of results per page (1-50). |
| queryrequired | string | Search query text matched against documentation titles and body content. |
| offset | integer | Zero-based item offset for pagination. |
| product | string | Filter results to a specific product. Use a value from the `c_productName` facet in the response (e.g. 'Citrix Virtual Apps and Desktops'). |
| version | string | Filter results to a specific version. Use a value from the `c_versionType` facet in the response (e.g. 'Current Release', '2511'). |
| file_type | string | Filter results by file type. Use a value from the `c_fileType` facet: 'HTML' or 'PDF'. |
{
"type": "object",
"fields": {
"limit": "integer page size used",
"facets": "object mapping facet field IDs to arrays of options with name and count",
"offset": "integer offset used",
"results": "array of documentation search result objects",
"total_results": "integer total number of matching documents"
},
"sample": {
"limit": 3,
"facets": {
"c_fileType": [
{
"name": "HTML",
"count": 567
}
],
"c_productName": [
{
"name": "Citrix Virtual Apps and Desktops",
"count": 567
}
],
"c_versionType": [
{
"name": "Current Release",
"count": 247
}
]
},
"offset": 0,
"results": [
{
"id": "4bb1de8eb50fbfb864c57ff369042f07-CITRIXDOCS",
"url": "https://docs.citrix.com/en-us/citrix-virtual-apps-desktops/install-configure/load-balance-machines.html",
"date": "2025-03-07",
"title": "Load balance machines | Citrix Virtual Apps and Desktops 7 2411",
"product": "Citrix Virtual Apps and Desktops",
"snippet": "... has to offer. Load balancing is configured at the delivery group level...",
"file_type": "HTML"
}
],
"total_results": 567
}
}About the Citrix API
What the API Returns
The search_docs endpoint accepts a required query string matched against documentation titles and body content. Each response includes a results array of documentation objects alongside a total_results count, the offset and limit used, and a facets object. The facets field maps field IDs (c_productName, c_versionType, c_fileType) to arrays of options, each with a name and a count showing how many matching documents belong to that category.
Filtering and Pagination
Filtering is driven by facet values returned in prior responses rather than a fixed enumeration. Pass a value from c_productName to the product parameter to scope results to a specific Citrix product (e.g. Citrix Virtual Apps and Desktops). Use version with a value from c_versionType to target a release such as "Current Release". The file_type parameter accepts HTML or PDF from the c_fileType facet. Pagination is offset-based: increment offset by limit to walk through all matching documents up to total_results.
Coverage and Scope
The API covers the full docs.citrix.com documentation library, which spans products including Citrix DaaS, Citrix Virtual Apps and Desktops, Citrix ADC, Citrix Workspace, and many others. Both HTML reference pages and PDF guides appear in results when available. The date field on each result reflects the publication or last-update date of the document.
The Citrix API is a managed, monitored endpoint for docs.citrix.com — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when docs.citrix.com changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official docs.citrix.com API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Build an internal search tool that surfaces relevant Citrix documentation for IT support teams by querying the
queryparameter and displayingtitle,url, andsnippetfields. - Enumerate all documentation for a specific product version by combining the
productandversionfilters and paginating throughtotal_results. - Generate a structured index of available Citrix PDF guides by filtering
file_typetoPDFand collecting theurlandtitlefields. - Track documentation updates for a Citrix product by periodically querying and comparing the
datefield across results. - Populate a chatbot knowledge base with Citrix technical content by paginating through all HTML docs for a target product using
offsetandlimit. - Audit which Citrix products have the most documentation coverage by inspecting
countvalues in thec_productNamefacet returned on any broad query.
| 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 | 100 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 Citrix provide an official developer API for its documentation site?+
How do I find valid values to use for the `product` and `version` filter parameters?+
facets object in the response. The c_productName and c_versionType keys each contain arrays of options with name and count fields. Pass a name value directly to the product or version parameter in subsequent requests. This makes the filter values self-discovering — you do not need a separate lookup table.Does the API return the full body text of each documentation page?+
snippet — a short excerpt of matched body content — along with the title and url. Full page content is not returned in the response. You can fork this API on Parse and revise it to add a separate endpoint that fetches and returns full document text from the url field.What is the maximum number of results retrievable in a single request, and how does pagination work?+
limit parameter accepts values from 1 to 50. To retrieve beyond the first page, increment offset by limit on each subsequent call. The total_results field tells you the total number of matching documents so you can determine how many pages exist.Does the API cover Citrix Community forums or support knowledge base articles?+
c_fileType facet. Community posts and support KB articles from other Citrix subdomains are not included. You can fork this API on Parse and revise it to add an endpoint targeting those sources.