Skip to main content
Version: API v3.0.0 (Latest)

Getting Started

Welcome to the NINJIO API. Our platform enables seamless integration to enhance your security awareness, training and phishing programs. Here's what you can achieve using our API Gateway:

Receive Phishing Data​

Gain insights into phishing simulation results directly from NINJIO. Leverage this data to understand user behavior, track campaign effectiveness, and tailor your security awareness strategy.

Receive Training Data​

Access comprehensive training metrics, including completion rates, user progress, and engagement levels. Use this data to measure the effectiveness of your security training initiatives and ensure compliance with organizational standards.

Sync Users Between Platforms​

Easily synchronize user data between your systems and NINJIO, ensuring consistent user management and streamlined access to training content.

Manage Your Tenancy​

Resellers can read their tenant hierarchy, the customers beneath it, the template collections and bundles they hold, and the campaigns they deliver across customers.

Version 3.0.0​

This is version 3.0.0, and the version is part of the address:

https://apigw.goninjio.com/api/api_gateway/3.0.0/customer/employees/

Because the version is in the URL, 2.x keeps serving its own paths untouched and you can move one call at a time rather than migrating an integration in one go.

Three things are true of every endpoint here, and were true of almost none in 2.x:

  • Every list is paginated, and every list uses the same envelope. Rows arrive under data, with the same paging fields beside them.
  • Every filtered response tells you what it filtered on, under filters_applied.
  • Every error has the same shape: {"error": "..."}.

New to 3.0.0? Start with Pagination. Coming from 2.x? Start with Migrating from 2.x, which lists every endpoint whose shape changed.

Useful Resources​

Creating and updating

3.0.0 currently publishes the read endpoints. The workflows that create or modify data — onboarding employees, building groups, launching campaigns — are still served by 2.x, and their guides live under API v2.2.0. Mixing versions is supported: read through 3.0.0 and write through 2.x. Migrating from 2.x lists exactly which methods are still on the older paths.

In the following sections you'll find detailed information on how to authenticate, use the endpoints, and handle responses.