🔌 API Documentation

Staffups API

Powerful REST API to integrate Staffups templates and hosting into your applications. Deploy websites, manage templates, and automate your workflow.

Get Started in Minutes

Deploy your first website with just a few lines of code

Quick Example:
curl -X POST "https://api.staffups.com/api/deploy" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d "{"templateId": "portfolio", "subdomain": "my-site"}"

API Features

Everything you need to build powerful integrations

RESTful API

Standard REST endpoints for easy integration

Secure Authentication

JWT-based authentication with API keys

Global CDN

Lightning-fast global content delivery

Real-time Data

Live data updates and webhooks support

Rate Limiting

Fair usage policies to ensure stability

SDK Support

Official SDKs for popular languages

API Endpoints

Complete reference of all available endpoints

GET
/api/templates
Optional
1000/hour

Retrieve all available templates

GET
/api/templates/{id}
Optional
1000/hour

Get specific template details

POST
/api/deploy
Required
100/hour

Deploy a template to subdomain

GET
/api/user/sites
Required
1000/hour

Get user's deployed sites

PUT
/api/sites/{id}
Required
100/hour

Update site configuration

DELETE
/api/sites/{id}
Required
50/hour

Delete a deployed site

Code Examples

Get started quickly with these code snippets

Deploy a Template

JavaScript
const response = await fetch('/api/deploy', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    templateId: 'portfolio-template',
    subdomain: 'my-portfolio',
    customizations: {
      title: 'My Portfolio',
      description: 'Welcome to my work'
    }
  })
});

const result = await response.json();
console.log(result.siteUrl); // https://my-portfolio.staffups.in

List Templates

Python
import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY'
}

response = requests.get('https://api.staffups.com/api/templates', headers=headers)
templates = response.json()

for template in templates:
    print(f"Template: {template['name']}")
    print(f"Category: {template['category']}")
    print(f"Price: ${template['price']}")

Get Site Analytics

cURL
curl -X GET "https://api.staffups.com/api/sites/123/analytics" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Response:
{
  "siteId": "123",
  "visitors": 1250,
  "pageViews": 3400,
  "bounceRate": 0.45,
  "avgSessionDuration": 180
}

Authentication

Secure your API calls with JWT tokens

Getting Your API Key

  1. 1Sign up for a Staffups account
  2. 2Go to your dashboard settings
  3. 3Generate a new API key
  4. 4Include it in your requests

Using Your API Key

Include in headers:
Authorization: Bearer YOUR_API_KEY

Ready to Get Started?

Start building with our API today and deploy websites programmatically.