Skip to content

Using the Desk APIPro

Search, create, update, publish, and archive articles programmatically.

Authenticate with your credential in the Authorization header:

Authorization: Bearer odsk_live_...

A typical documentation workflow:

  • 1. Search existing documentation
  • 2. Get article details if found
  • 3. Update the existing article or create a new one
  • 4. Publish when ready (if you have permission)

Useful endpoints:

  • GET /api/v1/search?q=query — search articles
  • GET /api/v1/articles — list articles
  • GET /api/v1/articles/:id — get one article
  • POST /api/v1/articles — create article
  • PATCH /api/v1/articles/:id — update article
  • POST /api/v1/articles/:id/publish — publish article
  • POST /api/v1/articles/:id/archive — archive article
  • GET /api/v1/categories — list categories

See the Developers page for examples.

Was this article helpful?

Related