Quickstart
This guide will get you all set up and ready to use the Support Station API. We'll cover how to get your API key and how to make your first API request to create a support ticket.
Before you can make requests to the Support Station API, you will need to create an API key from your dashboard. You can find it under Settings » API Keys.
Get your API key
API keys are organization-scoped and provide access to your Support Station data. To create an API key:
- Log in to your Support Station dashboard
- Navigate to Settings > API Keys
- Click Create API Key
- Select the scopes you need (e.g.,
tickets:write,customers:read) - Copy and securely store your API key
API keys start with sk_live_ for production or sk_test_ for test environments.
Keep your API keys secure and never expose them in client-side code.
Making your first API request
After creating your API key, you're ready to make your first call to the Support Station API. Below is an example of how to create a new support ticket using cURL.
curl -X POST https://api.supportstation.io/api/v1/tickets \
-H "Authorization: Bearer sk_live_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"subject": "Help with login",
"message": "I am unable to log into my account. I have tried resetting my password but it is not working.",
"priority": "MEDIUM",
"customer": {
"email": "john@example.com",
"name": "John Doe"
}
}'
This request creates a new ticket with an initial message. If the customer doesn't exist, they will be created automatically.
Response
{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"ticket_number": 42,
"subject": "Help with login",
"status": "OPEN",
"priority": "MEDIUM",
"channel": "API",
"customer": {
"id": "customer-uuid",
"email": "john@example.com",
"name": "John Doe"
},
"messages": [
{
"id": "message-uuid",
"content": "I am unable to log into my account...",
"type": "INBOUND",
"created_at": "2025-01-15T10:30:00.000Z"
}
],
"created_at": "2025-01-15T10:30:00.000Z",
"updated_at": "2025-01-15T10:30:00.000Z"
}
}
What's next?
Great, you're now set up with an API key and have made your first request to the API. Here are a few links that might be handy as you venture further into the Support Station API: