Title: Quick Start — First Kiteworks API Call in 10 Minutes
Open Graph Title: Quick Start — First Kiteworks API Call in 10 Minutes
X Title: Quick Start — First Kiteworks API Call in 10 Minutes
Description: Make your first Kiteworks REST API call in under 10 minutes. Step-by-step Python guide: authenticate with OAuth 2.0, list top-level folders, and read the response.
Open Graph Description: Make your first Kiteworks REST API call in under 10 minutes. Step-by-step Python guide: authenticate with OAuth 2.0, list top-level folders, and read the response.
X Description: Make your first Kiteworks REST API call in under 10 minutes. Step-by-step Python guide: authenticate with OAuth 2.0, list top-level folders, and read the response.
Opengraph URL: https://developer.kiteworks.com/quick-start.html
Domain: developer.kiteworks.com
{
"@context": "https://schema.org",
"@graph": [
{
"@type": "HowTo",
"name": "Make Your First Kiteworks API Call",
"description": "Authenticate with the Kiteworks REST API and list top-level folders using Python in under 10 minutes.",
"totalTime": "PT10M",
"step": [
{ "@type": "HowToStep", "position": 1, "name": "Authenticate", "text": "Use OAuth 2.0 Authorization Code or JWT Bearer flow to obtain an access token." },
{ "@type": "HowToStep", "position": 2, "name": "List top-level folders", "text": "Send GET /rest/folders/top with your Bearer token to retrieve all top-level folders." },
{ "@type": "HowToStep", "position": 3, "name": "Read the result", "text": "Parse the JSON response to access folder IDs, names, and metadata." }
]
},
{
"@type": "BreadcrumbList",
"itemListElement": [
{ "@type": "ListItem", "position": 1, "name": "Guides", "item": "https://developer.kiteworks.com/index.html" },
{ "@type": "ListItem", "position": 2, "name": "Getting Started", "item": "https://developer.kiteworks.com/index.html" },
{ "@type": "ListItem", "position": 3, "name": "Quick Start", "item": "https://developer.kiteworks.com/quick-start.html" }
]
},
{
"@type": "FAQPage",
"mainEntity": [
{ "@type": "Question", "name": "How long does it take to make a first Kiteworks API call?", "acceptedAnswer": { "@type": "Answer", "text": "Most developers make their first successful API call within 10 minutes, assuming they have a licensed Kiteworks instance and a registered custom application." } },
{ "@type": "Question", "name": "Does the Kiteworks API support languages other than Python?", "acceptedAnswer": { "@type": "Answer", "text": "Yes. The Kiteworks REST API is language-agnostic — any HTTP client can call it. JavaScript, Java, Go, Ruby, and any language with an HTTP library are all supported." } },
{ "@type": "Question", "name": "What does GET /rest/folders/top return?", "acceptedAnswer": { "@type": "Answer", "text": "GET /rest/folders/top returns a JSON array of top-level folders your access token can see, each with an id, name, type, and permission metadata." } },
{ "@type": "Question", "name": "How do I attach a Kiteworks access token to API requests?", "acceptedAnswer": { "@type": "Answer", "text": "Include the access token in the HTTP Authorization header as a Bearer token: Authorization: Bearer . This header must be present on every API request." } }
]
}
]
}
| og:type | article |
| og:image | https://developer.kiteworks.com/assets/kitework_logos/Kiteworks Favicon_96x96.svg |
| twitter:card | summary |
Links:
Viewport: width=device-width, initial-scale=1.0
Robots: index, follow