Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: SmartLead Authentication API
version: 1.0.0
description: '# SmartLead API Documentation
Welcome to the SmartLead API! SmartLead is a comprehensive cold email outreach platform that helps you manage email campaigns, leads, email accounts, and analytics.
## Base URL
All API requests should be made to:
```
https://server.smartlead.ai/api
```
## Authentication
SmartLead uses API keys for authentication. Include your API key as a query parameter in all requests:
```
?api_key=YOUR_API_KEY
```
You can generate your API key from your SmartLead dashboard under Settings > API Keys.
## Rate Limiting
API requests are rate-limited to ensure fair usage. If you exceed the rate limit, you''ll receive a 429 error.
## Support
For API support, contact support@smartlead.ai or visit https://smartlead.ai
'
contact:
name: SmartLead Support
email: support@smartlead.ai
url: https://smartlead.ai
license:
name: Proprietary
url: https://smartlead.ai/terms
servers:
- url: https://server.smartlead.ai/api
description: Production server
- url: https://staging.smartlead.ai/api
description: Staging server (for testing)
security:
- ApiKeyAuth: []
tags:
- name: Authentication
description: User authentication and account management
paths:
/v1/users/get-by-api-key:
get:
tags:
- Authentication
summary: Get User by API Key
description: 'Retrieves user information based on the provided API key.
'
operationId: getUserByApiKey
parameters:
- $ref: '#/components/parameters/ApiKeyParam'
responses:
'200':
description: User information retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'401':
$ref: '#/components/responses/UnauthorizedError'
'500':
$ref: '#/components/responses/InternalServerError'
components:
responses:
UnauthorizedError:
description: Unauthorized - Invalid or missing API key
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Invalid API Key
example:
message: Invalid API Key
InternalServerError:
description: Internal server error
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Internal server error occurred
parameters:
ApiKeyParam:
name: api_key
in: query
description: Your SmartLead API key for authentication
required: true
schema:
type: string
example: REDACTED_STRIPE_KEY
schemas:
User:
type: object
properties:
id:
type: integer
description: Unique user identifier
email:
type: string
format: email
description: User email address
name:
type: string
description: User full name
company:
type: string
description: Company name
account_type:
type: string
enum:
- FREE
- STARTER
- PRO
- ENTERPRISE
description: Account subscription type
api_key:
type: string
description: User API key
created_at:
type: string
format: date-time
is_agency:
type: boolean
description: Whether user has agency features enabled
client_id:
type: integer
nullable: true
description: Associated client ID if user is a client
subscription_status:
type: string
enum:
- ACTIVE
- CANCELED
- EXPIRED
- TRIAL
securitySchemes:
ApiKeyAuth:
type: apiKey
in: query
name: api_key
description: 'Your SmartLead API key. You can generate this from your dashboard under Settings > API Keys.
Include this as a query parameter in all API requests:
```
?api_key=YOUR_API_KEY
```
'