API Reference

YS Desk REST API requests use authenticated workspace sessions rather than long-lived developer API keys.

Workspace-authenticated requests use an Auth0 RS256 Bearer JWT together with the workspace context required by the endpoint.

Web Chat visitor requests use a signed Visitor Session token through the x-visitor-session header.

YS Desk does not expose a generic long-lived developer API key for REST API access.

Endpoint paths in this reference are documented exactly as implemented. YS Desk does not use a global /api/v1 route prefix. Do not prepend /api/v1 to the documented paths.

YS Desk does not provide a general-purpose developer API-key system. Workspace API access uses Auth0 Bearer JWT authentication with Workspace context, while Web Chat Visitor operations use signed Visitor Session authentication.

Need Help?

Email: support@ysdesk.com

Documentation: https://docs.ysplugins.com/ys-desk