Litestartup

Litestartup API Documentation

Client API v2 - RESTful API for email and marketing operations

Base URL

https://api.litestartup.com/client/v2

Authentication

API requests can be authenticated using:

  1. API Key (for server-to-server): 
    Authorization: Bearer sk_live_xxxxxxxxxxxxx

Verify API Key

curl -X GET https://api.litestartup.com/client/v2/verify \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxx"

Success Response

{
  "uuid": "xxxxxxxxxxxxx"
}

API Endpoints

Emails List (Folders)

Method Endpoint Description
GET /emails/inbox List inbox emails
GET /emails/sent List sent emails
GET /emails/draft List draft emails
GET /emails/trash List trash emails
GET /emails/spam List spam emails

Outbound Emails (Sending)

Method Endpoint Description
POST /emails Send email
GET /emails List sent emails
GET /emails/{id} Get email details
DELETE /emails/{id} Delete email

Inbound Emails (Receiving)

Method Endpoint Description
GET /emails/receiving List received emails
GET /emails/receiving/{id} Get received email details
DELETE /emails/receiving/{id} Delete received email
POST /emails/receiving/{id}/reply Reply to email
POST /emails/receiving/{id}/forward Forward email

Attachments

Method Endpoint Description
GET /emails/receiving/{id}/attachment List attachments
GET /emails/receiving/{id}/attachment/{attachmentId} Download attachment
DELETE /emails/receiving/{id}/attachment/{attachmentId} Delete attachment

Contacts

Method Endpoint Description
GET /contacts/list List contacts
POST /contacts/add Add contact
GET /contacts/search Search contacts
GET /contacts/get Get contact
PUT /contacts/update Update contact
DELETE /contacts/delete Delete contact
POST /contacts/import Import contacts
GET /contacts/export Export contacts

Contacts Tags

Method Endpoint Description
GET /tags/list List tags
POST /tags/create Create tag
PUT /tags/update Update tag
DELETE /tags/delete Delete tag

Marketing Campaigns

Method Endpoint Description
GET /marketing/list List campaigns
GET /marketing/{id} Get campaign detail
GET /marketing/{id}/report Get campaign report
POST /marketing/create Create campaign
PUT /marketing/update/{id} Update campaign
POST /marketing/copy/{id} Copy campaign
DELETE /marketing/delete/{id} Delete campaign
POST /marketing/test Send test email

Templates

Method Endpoint Description
GET /templates/list List templates
GET /templates/{id} Get template detail
POST /templates/create Create template
PUT /templates/update/{id} Update template
POST /templates/copy/{id} Copy template
GET /templates/content/{id} Get template content
DELETE /templates/delete/{id} Delete template

Domains

Method Endpoint Description
GET /domains/list List domains
GET /domains/{slug} Get domain detail
POST /domains/add Add domain
POST /domain/submit-domain-verify Submit domain verification
GET /domain/domain-verify-polling Poll verification status
PUT /domain/config/{domainSlug} Configure domain
PUT /domain/update/{domainSlug} Update domain
DELETE /domain/{domainSlug} Delete domain

Domain Emails

Method Endpoint Description
GET /domain-emails/list List domain emails
GET /domain-emails/{id} Get domain email detail
POST /domain-emails/add Add domain email
PUT /domain-emails/{emailId} Update domain email
DELETE /domain-emails/{emailId} Delete domain email

Team

Method Endpoint Description
POST /team/create Create team
POST /team/invite Invite member
PUT /team/set-default Set default team
DELETE /team/member/{userId} Remove member
PUT /team/member/{userId}/role Update member role

Response Format

All API responses follow this format:

{
  "code": 200,
  "message": "Success",
  "data": { ... }
}

Common HTTP Status Codes

Code Description
200 Success
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid API key or token
403 Forbidden - Access denied
404 Not Found
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error

Quick Start

1. Verify your API key

curl -X GET https://api.litestartup.com/client/v2/verify \
     -H 'Authorization: Bearer sk_live_xxxxxxxxxxxxx'

2. Send your first email

curl -X POST https://api.litestartup.com/client/v2/emails \
     -H 'Authorization: Bearer sk_live_xxxxxxxxxxxxx' \
     -H 'Content-Type: application/json' \
     -d '{
  "to": "[email protected]",
  "from": "Your Name <[email protected]>",
  "subject": "Hello from Litestartup!",
  "html": "<h1>Welcome!</h1><p>This is your first email via API.</p>"
}'

3. Check sent emails

curl -X GET https://api.litestartup.com/client/v2/emails \
     -H 'Authorization: Bearer sk_live_xxxxxxxxxxxxx'

Support

Last updated: January 30, 2026

Last updated: February 11, 2026