API Overview

API Introduction

The Jodie REST API provides programmatic access to your call data and account information. This allows you to build custom integrations, automate workflows, and retrieve call information for use in your own applications and systems.

Key Features

  • Retrieve Call Data: Access your complete call history with detailed information
  • User Information: Get details about the authenticated user and their account
  • Secure Access: Industry-standard OAuth 2.0 authentication protects your data
  • Real-time Updates: Access the latest call information as it becomes available, or get it pushed to you with webhooks
  • Multi-tenant Isolation: Automatic data separation ensures you only see your company's data

Prerequisites

Before you begin integrating with the API, you'll need:

  • An active Jodie account with USER role permissions
  • An OAuth 2.0 access token (see Authentication)
  • Basic understanding of REST APIs and HTTP requests
  • A tool for making API requests (cURL, Postman, or similar)

Included on Enterprise plans. The REST API comes with Enterprise. On other plans, ask us about adding API access.

Want activity pushed to you as it happens instead? Webhooks are included on Professional, Premium and Enterprise plans and free trials.

API Basics

  • Current Version: v1
  • Base URL: https://app.heyjodie.com/api/oauth
  • Protocol: HTTPS only (HTTP is not supported)
  • Data Format: JSON for both requests and responses
  • Character Encoding: UTF-8

Versioning

The API currently operates on version 1. Future versions will be announced with advance notice, and we maintain backward compatibility whenever possible. Breaking changes will result in a new API version.

Available Endpoints

User Information

  • GET /api/oauth/me - Retrieve authenticated user details

Call Data

  • GET /api/oauth/zapier/calls - List calls with pagination

WhatsApp Conversation Data

  • GET /api/oauth/zapier/conversations - List WhatsApp conversations with pagination

Quick Start

  1. Obtain an OAuth token - See Authentication guide
  2. Test your connection - Try the GET /api/oauth/me endpoint
  3. Retrieve calls - Use GET /api/oauth/zapier/calls to fetch your data
  4. Retrieve conversations - Use GET /api/oauth/zapier/conversations to fetch WhatsApp data

Support

For technical support or questions about the API:

  • Email: [email protected]
  • Documentation: Browse the sections in the navigation
  • Status Page: Check your application's status page for known issues

Need a hand?

Our team can help you connect Jodie to your systems.

Email [email protected]