Skip to main content
The Theymes API allows you to interact with Theymes platform programmatically. You can use it to access and manage resources.

​
Base URL

Use https://api.theymes.com/v2 for new integrations. customerId is the identifier supplied by your app. theymesCustomerId is the internal Theymes identifier returned by the ticket API. The OpenAPI specification describes the v2 endpoints and schemas. Existing integrations using unversioned URLs continue to work with their original contracts.

​
Authentication

Most endpoints require authentication using an API key. You can generate an API key from the Theymes support app. API keys must be included in the Authorization header of each request.

​
Public endpoints (no authentication)

A small number of endpoints are public and do not require an API key. These are the support link endpoints, which create a web support session and return (or redirect to) a public support URL. Instead of an API key, they identify the app using its app environment token. In the reference documentation these endpoints are listed under the Public (no authentication) group, separate from the authenticated endpoints under Authenticated (API key).

​
Reference documentation

You can find the full reference documentation for the Theymes API here. Support sessions accept unsigned customer metadata. The contents of signedMetadataToken continue to follow the existing SDK metadata signing protocol.