Quick Start Guide
Go from zero to your first API call in under 5 minutes. This guide covers SDK installation, authentication, and making requests to the EventZR platform.
Prerequisites
- Node.js 18+ installed (
node --version) - An EventZR developer account (free tier available)
- A tenant ID and API key from the Developer Console
Install the SDK
Install the EventZR JavaScript/TypeScript SDK using your preferred package manager.
NPM
npm install @eventzr/sdkPNPM
pnpm add @eventzr/sdkYARN
yarn add @eventzr/sdkTip: For service-specific clients (e.g., events only), you can install individual packages like @eventzr/event-client or @eventzr/ticketing-client.
Get Your API Key
Generate an API key from the Developer Console to authenticate your requests.
- Sign in to the Developer Console
- Navigate to Settings → API Keys
- Click Generate New Key
- Copy your key (starts with
ez_live_)
Store the key in an environment variable. Never commit it to version control.
# .env.local (for Next.js projects)
EVENTZR_API_KEY=ez_live_your_api_key_here
EVENTZR_TENANT_ID=00000000-0000-4000-a000-000000000001Security: API keys carry your account permissions. Treat them like passwords. Rotate keys immediately if compromised.
Make Your First API Call
Initialize the client and fetch a list of events. This example demonstrates authentication, tenant isolation, and the standard response envelope.
TYPESCRIPT
import { EventSvcClient } from '@eventzr/event-client';
const client = new EventSvcClient({
baseUrl: 'https://api.eventzr.com/event/v1',
tenantId: process.env.EVENTZR_TENANT_ID,
headers: {
Authorization: `Bearer ${process.env.EVENTZR_API_KEY}`,
},
});
// List published events
const events = await client.events.findAll({
status: 'published',
limit: 10,
});
console.log(`Found ${events.data.length} events`);
for (const event of events.data) {
console.log(` - ${event.title} (${event.status})`);
}CURL EQUIVALENT
curl https://api.eventzr.com/event/v1/events?status=published&limit=10 \
-H "Authorization: Bearer $EVENTZR_API_KEY" \
-H "x-tenant-id: 00000000-0000-4000-a000-000000000001"RESPONSE
{
"data": [
{
"id": "evt_abc123",
"title": "Tech Conference 2026",
"status": "published",
"start_at": "2026-06-15T09:00:00Z"
},
{
"id": "evt_def456",
"title": "Music Festival",
"status": "published",
"start_at": "2026-07-20T18:00:00Z"
}
],
"page": {
"next_cursor": "eyJpZCI6Mn0=",
"has_more": true,
"limit": 10
},
"meta": {
"request_id": "req_xyz789"
}
}Success! You have made your first API call. All responses follow the standard envelope format with data, page, and meta fields.
Understanding the Response Envelope
Every API response uses a consistent envelope structure:
| Field | Type | Description |
|---|---|---|
| data | object | array | The requested resource(s) |
| error | object | null | Error details (null on success) |
| page | object | Cursor-based pagination (next_cursor, has_more, limit) |
| meta | object | Request metadata (request_id) |
Next Steps
API Reference
Explore all endpoints across 62+ services with request/response examples.
Authentication Guide
Learn about JWT tokens, OAuth flows, MFA, and session management.
Sandbox Environment
Test your integration with sandbox keys and test data.
Swagger Explorer
Try API endpoints interactively with the built-in Swagger UI.
Need help? Check the Authentication Guide if you encounter 401 errors, or visit the Status Page to check service availability.