Skip to Content
Kismet's Organization API is officially released 🎉
APIGetting Started

Getting Started

This guide will help you get started with the Kismet Organization API.

Prerequisites

Before you begin, you’ll need:

  • A Kismet Organization account
  • API credentials (Client ID and Client Secret)
  • Basic knowledge of REST APIs and HTTP requests

Quick Start

1. Obtain API Credentials

Create your api key and secret in your dashboard.

  • Client ID: Your unique client identifier
  • Client Secret: Your secret key for authentication

2. Make Your First Request

Here’s an example of how to list organization users:

curl -X GET "https://api.kismethealth.com/api/external/organization_users" \
  -H "X-Client-ID: your-client-id" \
  -H "X-Client-Secret: your-client-secret" \
  -H "Content-Type: application/json"

3. Handle the Response

A successful response will return a JSON object with user data:

{
  "organization_users": [
    {
      "id": 1,
      "email": "user@example.com",
      "is_admin": true,
      "display_name": "Jane Doe",
      "waiting_room_url": "https://app.kismethealth.com/meet/janes-room",
      "created_at": "2025-07-16T14:00:00Z",
      "updated_at": "2025-07-16T14:05:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_pages": 4,
    "total_count": 100
  }
}

Common Patterns

Pagination

Many endpoints support pagination with these query parameters:

  • page: Page number (default: 1)
  • per_page: Items per page (default: 25)

Error Handling

The API returns standard HTTP status codes:

  • 200: Success
  • 204: No content (for deletions)
  • 400: Bad request
  • 401: Unauthorized
  • 404: Not found
  • 429: Too many requests
  • 500: Internal server error

Rate Limits

Please be respectful of our API rate limits. If you need higher limits, contact our support team.

Next Steps

Last updated on
Kismet Organization API DocumentationAuthentication