Skip to main content

​
Quickstart

This guide will help you make your first API request in just a few minutes.

​
Prerequisites

  • A My Virtual Office account with seller access
  • An API key (see Authentication for how to generate one)

​
Step 1: Get Your API Key

  1. Log in to your My Virtual Office dashboard
  2. Go to Settings > API Keys
  3. Click Generate API Key
  4. Copy your new API key
Remember: Your API key is only shown once. Store it securely!

​
Step 2: Make Your First Request

Let’s create a customer using the API. Choose your preferred method: 
curl -X POST https://api.my-virtual-office.com/api/customers \
  -H "X-API-Key: sk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "company_name": "Acme Inc",
    "language": "en"
  }'

​
Step 3: Understand the Response

A successful request returns the created customer: 
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "seller_id": "660e8400-e29b-41d4-a716-446655440001",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "company_name": "Acme Inc",
  "legal_entity": null,
  "language": "en",
  "address_data": null,
  "source": "api",
  "created_at": "2024-01-15T10:30:00.000Z",
  "updated_at": "2024-01-15T10:30:00.000Z"
}

​
Common Use Cases

CRM Integration

Automatically create My Virtual Office customers when new contacts are added to your CRM

Website Forms

Create customers from sign-up forms on your website

Bulk Import

Migrate existing customers from other systems

Automation

Build automated workflows with Zapier, Make, or custom scripts

​
Next Steps

Explore the API Reference

Learn about all available endpoints and parameters

Error Handling

Learn how to handle API errors gracefully