vcity logo
HomeSolutionsExplore
FOR DEVELOPERS

Build on vcity

Public REST API, official CLI, and TypeScript SDK. Query orgs, products, events, orders, bookings and quotes — programmatically.

Install the CLI

Everything you need to ship

A modern API surface plus tooling to integrate vcity into your stack.

REST API

Read endpoints for orgs, products, events, orders, bookings and quotes. Versioned at /api/v1. OpenAPI 3.1.

Bearer auth with API keys

Generate per-org keys from your org admin panel. Scoped to a single org. Rotate or revoke anytime.

Official TypeScript SDK

@vcityio/api-client — typed responses generated from the OpenAPI spec. ESM, Node 20+ and modern browsers.

vcity CLI

Authenticate via device flow, list your orgs, switch context, and browse products from your terminal.

Webhooks

Soon

React to events — orders, RSVPs, payments — in your own services.

OpenAPI explorer

Browse every endpoint with examples at /docs/api. Try requests right from the page.

Get your API key in two minutes

Keys live inside your organization dashboard. Each key is scoped to a single org and can be rotated or revoked at any time.

  1. 1

    Create or pick an organization

    Go to your org admin panel.

  2. 2

    Open the API Keys tab

    Found under your org admin settings at /orgs/<id>/admin/api-keys.

  3. 3

    Generate and copy

    The full secret is shown once — store it securely. Use it as a Bearer token in the Authorization header.

Open my orgs →
Authorization header
Authorization: Bearer vck_live_xxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

Install the CLI

One-line install. Authenticates via device flow — no passwords, no copying tokens.

Install
curl -fsSL https://vcity.io/cli/install.sh | bash
Log in
vcity login
Run a command
vcity orgs list

Talk to the API

Use curl directly or the official TypeScript SDK.

bash
curl https://vcity.io/api/v1/orgs/your-org/products \
  -H "Authorization: Bearer $VCITY_API_KEY" \
  -H "Content-Type: application/json"

What you can build

Today the API is read-first — perfect for dashboards, syncs out of vcity, and integrations. Write endpoints land next.

Mirror your catalog

Pull products from vcity into your ERP, PIM, or marketing site. Keep external surfaces in sync.

Event analytics

Read events and bookings into your own dashboards or BI tooling.

Order reporting

Stream orders into your data warehouse for reconciliation, finance, and analytics.

Embedded admin tools

Build internal dashboards over your org's products, events, and orders without rebuilding the UI.

Two-way sync (writes)

Soon

Push products, create events, and update orders from your own systems. Write endpoints coming soon.

Webhooks-driven workflows

Soon

Trigger Slack alerts, CRM updates, or fulfillment when a sale or RSVP happens.

Open source on GitHub

Both the CLI and TypeScript client are open and versioned with npm.

@vcityio/cli on npm →@vcityio/api-client on npm →View on GitHub →

Start building

Free to try, no credit card. The API is the same engine that powers vcity.io.

Read the API docs →Install the CLI