API Documentation

REST API reference

Scale Virtually API

v1.0 · REST · JSON

Build custom integrations with our RESTful API. All endpoints accept and return JSON. Authentication is required via API key in the request header.

# Base URL

https://api.scalevirtually.com/v1

Authentication

Include your API key in the Authorization header:

# Example request

curl -H "Authorization: Bearer sk_live_your_api_key" \

https://api.scalevirtually.com/v1/jobs

sk_live_••••••••••••••••

Rate Limits

1,000

requests/min

100

per endpoint/min

10MB

max request size

Endpoints

GET/api/jobs

List all jobs

// Response

[{ "id": "job-1", "title": "Executive Virtual Assistant", "status": "published", ... }]

POST/api/jobs

Create a new job

// Response

{ "id": "job-123", "title": "...", "status": "draft" }

GET/api/jobs/:id

Get job details

// Response

{ "id": "job-1", "title": "...", "description": "...", "requirements": [...] }

PATCH/api/jobs/:id

Update a job

// Response

{ "id": "job-1", "title": "Updated Title", ... }

DELETE/api/jobs/:id

Delete a job

// Response

{ "success": true }

GET/api/candidates

List all candidates

// Response

[{ "id": "cand-1", "firstName": "Maria", "lastName": "Santos", ... }]

POST/api/candidates

Create a candidate

// Response

{ "id": "cand-123", "firstName": "...", "email": "..." }

PATCH/api/applications/:id

Update application (move pipeline stage)

// Response

{ "id": "app-1", "stage": "interview", ... }

POST/api/careers/:jobId/apply

Submit public application

// Response

{ "candidate": {...}, "application": {...} }

Webhooks

Subscribe to real-time events. Configure webhook URLs in Settings > Integrations.

candidate.applied

candidate.stage_changed

candidate.hired

job.created

job.published

interview.scheduled

offer.sent

offer.accepted