Getting Started

Learn how to integrate with codmir in just a few minutes.

Create an API Key

Generate API credentials to authenticate your requests.

Go to your API Settings page to create a new API key. You can create multiple keys with different scopes for different purposes.

Create API Key

Install the SDK

Install our official SDK for your preferred language.

npm install @codmir/sdk

Make Your First Request

Use the SDK to interact with the codmir API.

import { CodmirClient } from '@codmir/sdk';

const client = new CodmirClient({
  apiKey: process.env.CODMIR_API_KEY,
});

// List all projects
const projects = await client.listProjects();
console.log(projects);

// Create a new ticket
const ticket = await client.createTicket({
  projectId: 'proj_abc123',
  title: 'My first ticket',
  description: 'Created via API',
});

What's Next?

API Reference

Explore all available endpoints and their parameters.

Set Up Webhooks

Receive real-time notifications when events occur.

💡 Pro Tips

Store your API key in environment variables, never in code.
Use pagination for endpoints that return lists to avoid timeouts.
Implement exponential backoff for rate-limited requests.
Use webhooks instead of polling for real-time updates.