Skip to main content
This guide walks you through creating an API key, configuring authentication, and verifying your connection to the Sterndesk API.

​
Before you begin

You’ll need:
  • A Sterndesk account.
  • Access to a Sterndesk organization.
  • A personal API key.
  • A tool capable of making HTTP requests, such as cURL.

​
1. Create an API key

Sign in to Sterndesk and go to: Settings → My account → API Keys 37 Click Create API key and configure your key. Choose a descriptive name so you can identify what the key is being used for later. Select the permissions required by your integration and create the key.
Important
Your API key is shown only once after creation. Copy and store it securely. You won’t be able to view the full key again.

​
2. Store your API key

For local development, you can store your API key in an environment variable:
Avoid hard-coding API keys directly into your application.

​
3. Make your first request

Use the WhoAmI operation to verify that your API key is working.
The request authenticates using your personal API key and returns information associated with the authenticated API context. If the request succeeds, your API key is configured correctly and you can start calling other available operations.

​
4. Explore the API

Sterndesk uses Connect RPC over HTTP/JSON. API operations are sent as POST requests to paths under /rpc/. Requests typically include:
The required JSON body depends on the operation you are calling. Use the API Reference to explore available operations, request schemas, responses, and required permissions. Explore the API Reference →

​
Next steps

Now that you’ve made your first request, you can:
  • Explore available operations in the API Reference.
  • Learn more about Authentication and API key permissions.
  • Use the API Reference playground to test individual operations.
  • Create separate API keys for different integrations or workflows when appropriate.