hassan@jumbula.com

Getting Started

Introduction

About the APIs

Authentication & Authorization

API Reference Guide

Basics of APIs

Base URL

Rest API Reference

Authentication API

Webhooks

Order API

Coupon API

Family API

Blank

Jumbula2

Production

Sandbox

<p class="slate-p " >Welcome to the <strong class="slate-bold">Jumbula API Documentation</strong>, your gateway to integrating applications and services with the Jumbula platform. The Jumbula API provides a structured, secure, and scalable way to manage core platform resources including families, staff, programs, tickets, coupons, and notifications. Whether you’re building internal tools, automating workflows, or creating external integrations, these APIs give you the flexibility and control you need.</p><p class="slate-p " >This documentation covers all available REST endpoints, grouped into logical categories to help you quickly navigate and implement the features relevant to your use case.</p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div >Title</div><div >Description</div></div><table class="slate-table" style="min-width:100%;"><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><td class="slate-td"><h4 class="slate-h4 " > Just getting started?</h4><p class="slate-p " >Check out our <a href="https://jumbula.com/pay-as-you-go/" target="_blank">Quickstart Guide.</a></p></td><td class="slate-td"><h4 class="slate-h4 " >🗓️ Need any assistance?</h4><p class="slate-p " ><a href="https://jumbula.com/book-a-demo/" target="_blank">Book a meeting</a></p></td></tr></tbody></table></div></div><p class="slate-p " ></p><p class="slate-p " ></p>

, your gateway to integrating applications and services with the Jumbula platform. The Jumbula API provides a structured, secure, and scalable way to manage core platform resources including families, staff, programs, tickets, coupons, and notifications. Whether you’re building internal tools, automating workflows, or creating external integrations, these APIs give you the flexibility and control you need.

This documentation covers all available REST endpoints, grouped into logical categories to help you quickly navigate and implement the features relevant to your use case.

Title

Description

<p class="slate-p " >The Jumbula API enables seamless integration with the Jumbula platform, allowing developers to manage families, programs, staff members, coupons, notifications, and support tickets through a structured and secure RESTful interface. This documentation provides a complete overview of all available endpoints, including request formats, response structures, and recommended usage practices.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Note:</strong> All endpoint specifications in this documentation are designed to help developers build reliable and scalable integrations with the Jumbula system.</p></div></div><h4 class="slate-h4 " ></h4><h4 class="slate-h4 " >Why Use the Jumbula API?</h4><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">RESTful architecture with predictable JSON structures </div></li><li class="slate-li " ><div style="position:relative">Secure authenticated requests using OAuth tokens </div></li><li class="slate-li " ><div style="position:relative">Logical grouping of resources for simple navigation </div></li><li class="slate-li " ><div style="position:relative">Scalable and reliable integration experience </div></li><li class="slate-li " ><div style="position:relative">Ideal for building apps, dashboards, automations, and custom workflows </div></li></ul><h4 class="slate-h4 " ></h4><h4 class="slate-h4 " >What You Can Do with the Jumbula API</h4><p class="slate-p " ><strong class="slate-bold">✔ Authentication &amp; Authorization</strong></p><p class="slate-p " >Use secure OAuth token generation to authenticate every request.</p><p class="slate-p " ><strong class="slate-bold">✔ Family Management</strong></p><p class="slate-p " >Create and manage families, participants, parents, emergency contacts, and authorized pickups with a comprehensive set of endpoints designed to handle real-world workflows.</p><p class="slate-p " ><strong class="slate-bold">✔ Program Management</strong></p><p class="slate-p " >Create, update, and control program details, staff assignments, and capacity information.</p><p class="slate-p " ><strong class="slate-bold">✔ Staff Management</strong></p><p class="slate-p " >Manage staff records, account activation states, invitations, restrictions, and operational status.</p><p class="slate-p " ><strong class="slate-bold">✔ Coupon Management</strong></p><p class="slate-p " >Create and update coupon codes to support promotions or discount workflows.</p><p class="slate-p " ><strong class="slate-bold">✔ Ticketing System</strong></p><p class="slate-p " >Submit, retrieve, and respond to support tickets, download attachments, and view full ticket threads.</p><p class="slate-p " ><strong class="slate-bold">✔ Web Notifications</strong></p><p class="slate-p " >Subscribe users, manage their notification endpoints, resend notifications, and fetch preview/sample data.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Why This API Exists</h3><p class="slate-p " >The Jumbula API is built to help organizations:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Automate repetitive administrative workflows </div></li><li class="slate-li " ><div style="position:relative">Sync Jumbula data with internal systems </div></li><li class="slate-li " ><div style="position:relative">Extend Jumbula functionality without relying on manual operations </div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >What’s Inside This Documentation</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Endpoint descriptions for every API category </div></li><li class="slate-li " ><div style="position:relative">Required parameters and request body schemas </div></li><li class="slate-li " ><div style="position:relative">Response formats and status codes </div></li><li class="slate-li " ><div style="position:relative">Authentication rules </div></li><li class="slate-li " ><div style="position:relative">Real-world examples and usage notes </div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

The Jumbula API enables seamless integration with the Jumbula platform, allowing developers to manage families, programs, staff members, coupons, notifications, and support tickets through a structured and secure RESTful interface. This documentation provides a complete overview of all available endpoints, including request formats, response structures, and recommended usage practices.

Use secure OAuth token generation to authenticate every request.

Create and manage families, participants, parents, emergency contacts, and authorized pickups with a comprehensive set of endpoints designed to handle real-world workflows.

Create, update, and control program details, staff assignments, and capacity information.

Manage staff records, account activation states, invitations, restrictions, and operational status.

Create and update coupon codes to support promotions or discount workflows.

Submit, retrieve, and respond to support tickets, download attachments, and view full ticket threads.

Subscribe users, manage their notification endpoints, resend notifications, and fetch preview/sample data.

The Jumbula API is built to help organizations:

<p class="slate-p " >Generate an OAuth access token to authenticate requests across all Jumbula API endpoints. This endpoint supports multiple authentication flows including username/password, refresh token, and external identity providers.</p><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " ><strong class="slate-bold">Purpose</strong></h2><p class="slate-p " >This endpoint issues an access token (<code class="slate-code">access_token</code>) and a refresh token (<code class="slate-code">refresh_token</code>) that must be used for authorized requests throughout the Jumbula API.
 All tokens follow standard OAuth security practices and include expiration rules.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Generate an OAuth access token to authenticate requests across all Jumbula API endpoints. This endpoint supports multiple authentication flows including username/password, refresh token, and external identity providers.

) that must be used for authorized requests throughout the Jumbula API.
 All tokens follow standard OAuth security practices and include expiration rules.

<p class="slate-p slate-indent-0" style="0px">
<span style="background-color:rgb(255, 255, 255);color:rgba(20, 23, 25, 0.84)">Generate an OAuth access token to authenticate requests across all Jumbula API endpoints. This endpoint supports multiple authentication flows including username/password, refresh token, and external identity providers.</span></p><p class="slate-p " ></p><h3 class="slate-h3 " >HTTP Methods</h3><p class="slate-p " >HTTP methods, or verbs, denote actions performed on resources. Theneo APIs support various HTTP methods:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">GET:</strong> Retrieve a representation of a specific resource.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Retrieving transaction details.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">POST:</strong> Submit data to create a new resource or trigger a state change.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Creating a new customer profile.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">PUT:</strong> Replace all representations of a target resource with the provided payload.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Updating a subscription plan.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">DELETE:</strong> Remove a specified resource.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Deleting a stored card.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">PATCH:</strong> Apply partial modifications to a resource.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Changing the status of an existing order.</div></li></ul></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Parameters</h3><p class="slate-p " >Parameters allow customization of API requests and responses. Theneo APIs support four types of parameters:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Path Parameters:</strong> Integral parts of the endpoint URL, identifying specific resources.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Query Parameters:</strong> Appended to the endpoint URL to filter or paginate results.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Request Body Parameters:</strong> Included in the request body, transmitting data to the API server.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Response Body Parameters:</strong> Represent data returned by the server in response to a request.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >HTTP Status Codes</h3><p class="slate-p " >HTTP status codes communicate the outcome of client requests. Theneo employs HTTP status codes categorized into the following classes:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Success (200):</strong> The request was successfully processed.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Successfully retrieved a resource or completed an action.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">400 (Bad Request):</strong> The server could not understand the request due to invalid syntax.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Missing required parameters in the request.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">401 (Unauthorized):</strong> Authentication is required and has failed or has not yet been provided.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Invalid or missing API key.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">402 (Request Failed):</strong> The parameters were valid but the request failed.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Insufficient funds or expired credit card.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">403 (Forbidden):</strong> The client does not have access rights to the content.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Attempting to access a resource without the necessary permissions.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">404 (Not Found):</strong> The server can not find the requested resource.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Trying to access an endpoint that does not exist.</div></li></ul></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

HTTP methods, or verbs, denote actions performed on resources. Theneo APIs support various HTTP methods:

Parameters allow customization of API requests and responses. Theneo APIs support four types of parameters:

HTTP status codes communicate the outcome of client requests. Theneo employs HTTP status codes categorized into the following classes:

The request was unacceptable, often due to missing a required parameter.

The parameters were valid but the request failed.

The API key doesnt have permissions to perform the request.

<p class="slate-p slate-indent-0" style="0px">The Base URL is a crucial element for making API calls, enabling you to clearly specify the root URL(s) for API requests. When making API calls, you combine the base URL with the specific endpoint path to form the complete request URL.</p><p class="slate-p slate-indent-0" style="0px">It supports multiple environments, including staging and production. Additionally, the base URL synchronizes with the API explorer, allowing you to seamlessly switch between environments like Sandbox and Production while trying out API calls.</p><p class="slate-p " ></p>

The Base URL is a crucial element for making API calls, enabling you to clearly specify the root URL(s) for API requests. When making API calls, you combine the base URL with the specific endpoint path to form the complete request URL.

It supports multiple environments, including staging and production. Additionally, the base URL synchronizes with the API explorer, allowing you to seamlessly switch between environments like Sandbox and Production while trying out API calls.

<div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Note:</strong> This endpoint allows you to securely obtain an access token that you can use to authenticate your requests across the Jumbula API.
 To use this endpoint, you will need a <strong class="slate-bold">clientId</strong> and <strong class="slate-bold">clientSecret</strong>, which are unique credentials assigned to your account.</p><p class="slate-p " >If you do not already have these credentials, please contact our support team by submitting a ticket. After verifying your request, our team will provide the required client credentials.</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

<div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Note:</strong> Our Webhooks provide a powerful way to build event-driven integrations with our platform. Instead of polling our API for updates, your application can receive real-time notifications whenever specific events occur—such as a new order being created or a family status being updated.</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

<div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Note:</strong>  All Order APIs allow you to manage orders within your Jumbula account. You can get all the order&apos;s information: Form, Waiver, transaction, and installment of an order.</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " >Use this API to get all order information by default with your Jumbula token. Use the <code class="slate-code">child</code> filter to <strong class="slate-bold">opt-in</strong> for related data. Including values like <code class="slate-code">installment</code> or <code class="slate-code">form</code> , … in the request will trigger the API to fill those specific objects in the response payload; otherwise, these fields will remain empty or be omitted</p><p class="slate-p " ></p>

Use this API to get all order information by default with your Jumbula token. Use the 

 for related data. Including values like 

 , … in the request will trigger the API to fill those specific objects in the response payload; otherwise, these fields will remain empty or be omitted

Get All order (copy)

Specifies the starting index (offset) from which the collection of results should begin.

form

Defines the maximum number of items to be returned in a single response page.

size

An optional array used to filter which nested related data should be included in the response.

child

The field name to be used for ordering the results.

sort

The direction of the sort; typically accepts "asc" or "desc".

sort order

A filter used to narrow down the results based on a specific businesstype.

businessType

A filter used to narrow down the results based on a specific business id.

businessId

A filter used to narrow down the results based on a specific season id.

seasonId

A filter used to narrow down the results based on a specific program.

programId

A filter used to narrow down the results based on a specific program schedule.

programScheduleId

A filter used to narrow down the results based on a specific semester.

semester

A filter used to narrow down the results based on a specific year.

year

A filter used to narrow down the results based on a specific status.

status

A filter used to narrow down the results based on the range of registration dates.

registrationDateRange

A filter used to narrow down the results based on the range of modified date

modifiedDateRange

A filter used to narrow down the results based on a specific program type.

programType

A filter used to narrow down the results based on a specific season status.

seasonStatus

A search filter that retrieves records based on a match with the first name, last name, or a combination of both.

name

A search filter that retrieves records based on a match with email.

email

A search filter that retrieves records based on a match with the confirmation id.

confirmationid

Filters the results to include only records associated with a specific unique identifier (ID) of a child entity.

childId

An array of identifiers used to filter the response to include only the specific records matching the provided IDs.

orderId

an identifiers used to filter the response to include only the specific record matching the provided internal ID.

OrderInternalId

An array of order modeused to filter the response to include only the specific records matching the provided modes.

orderMode

Specifies the media type expected in the response, typically text/plain.

Accept

Bearer token for authorizing the API request.

Authorization

Specifies the media type of the request body, typically application/json.

Content-Type

Contains the primary details and core metadata associated with the specific order record.

Order 

A collection of financial records detailing payments or transfers linked to the order.

Transaction

Details regarding breakdown and installments applied to the total order value.

breakdownAndInstallment

Details regarding additional service fees or price reductions applied to the total order value.

chargeAndDiscount

A list of structured data submissions or documentation attached to the order.

Form

Records of any legal exemptions or fee cancellations granted for the specific order.

Waiver

{
 [
    Order : Order’s info.
    Transaction: List of order’s Transactions.
    Installment: List of order’s Installments.
    ChargeAndDiscount: List of order’s ChargeAndDiscounts.
    Form: List of order’s Forms.
    Waiver: List of order’s Waivers.
 ]
}


<p class="slate-p " >Use this API to get forms information for a single order ID using your Jumbula token.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Use this API to get forms information for a single order ID using your Jumbula token.

Get forms by order-id

Get order's count by program

Original

Canceled

TransferredOut

TransferredIn

Total

ProgramId

ProgramscheduleGuid

<p class="slate-p " >This service gives you a quick count of all your orders. It helps you track your business growth and see how many orders are active, moved, or canceled without having to count them one by one.</p><p class="slate-p " ></p><p class="slate-p " ></p>

This service gives you a quick count of all your orders. It helps you track your business growth and see how many orders are active, moved, or canceled without having to count them one by one.

Get order's count

<p class="slate-p " >Use this API to get waiver information for a single ID using your Jumbula token.</p>

Use this API to get waiver information for a single ID using your Jumbula token.

Get waiver by id

Filters the query to return only the record associated with this unique primary key.


WaiverOriginalName

WaiverOriginalContent

Name

Content

Required

Text

Signature

Type

Status

<p class="slate-p " >If you need to investigate a specific payment—perhaps for a refund, an audit, or a customer dispute—this service provides every available detail about that single movement of money.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

If you need to investigate a specific payment—perhaps for a refund, an audit, or a customer dispute—this service provides every available detail about that single movement of money.

Get orders' item transaction

Limit

Offset

NoExternalIds

A filter used to narrow down the results based on a specific date range.

Range

A filter used to narrow down the results based on a specific payment mode.

PaymentMode

A filter used to narrow down the results based on a specific payment methods.

PaymentMethod

A filter used to narrow down the results based on a specific Gl-code.

GlCode

A filter used to narrow down the results based on a specific error category.

OrderType

A filter used to narrow down the results based on a specific transaction category

BusinessId

A filter used to narrow down the results based on a specific business type.

BusinessType

SeasonId

A filter used to narrow down the results based on a specific peogram id.

ProgramScheduleId

A filter used to narrow down the results based on a specific tution label

TuitionLabel

Semester

Year

Email

ConfirmationId

SeasonStatus

includeProfile

When true, the Form object is populated with data; otherwise, it remains empty or excluded.

includeForm

Business

Partner

Provider

Season

Participant

Program

Order

<p class="slate-p " >This API allows you to see the complete transaction history of an order. It shows exactly how much money was moved, when it happened, and the current status of that payment.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

This API allows you to see the complete transaction history of an order. It shows exactly how much money was moved, when it happened, and the current status of that payment.

Get orders' transactions

OrderItem 

<p class="slate-p " >This API allows you to view all the legal agreements and signed permissions associated with a specific order. When you use your access token,</p><p class="slate-p " > the system retrieves &quot;waivers&quot; taht the customer accepted and the status of those agreements.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

This API allows you to view all the legal agreements and signed permissions associated with a specific order. When you use your access token,

 the system retrieves "waivers" taht the customer accepted and the status of those agreements.

Get orders' Waiver

A filter used to narrow down the results based on a specific waiver category.

A filter used to narrow down the results based on a specific order status.

Sections