Administrate DX Logo
  • Please type at least 3 characters
  • Core
    • Welcome
    • Authorization
    • CRM
      • Accounts
      • Contacts
      • Individual Accounts
      • Sales Opportunities
    • Custom Fields
      • Custom Fields configuration
      • Custom Fields values
    • Documents
      • Search
      • Upload
      • Download
    • External IDs
      • External IDs Introduction
      • External ID values
    • Optimization
      • GraphQL Query Efficiency
    • Training
      • Course Templates
      • Events
      • Learning Paths
      • Locations
      • Registrations
      • Training Passes
      • Training Tokens
    • Webhooks
      • Types
      • Setup
      • Filtered Webhooks
      • Troubleshooting and Logs
    • API Reference
    • Upcoming API Changes
  • LMS
    • Welcome
    • Authorization
    • Achievements & Certifications
      • Get Achievements
    • Learners & Training
      • List Learners
      • List Managed Learner Training
      • List your Training
      • Specific Course Training
      • Details about specific Learning Path Training
    • Learning Objectives & Outcomes
      • Update the Progress of an Outcome
    • API Reference
    • Upcoming API Changes
  • WebLink
    • Welcome
    • Authorization
    • Cart
      • Query The Cart
      • Create a Cart
      • Add a line item to a Cart
    • Catalog
      • Load the Catalog
      • Catalog Filters
      • Course Details
      • Learning Path Details
      • Categories
      • Text Search
    • Checkout
      • Introduction
      • Prepare Items for Checkout
      • Buyer details
      • Learner Details
      • Review Cart
      • Checkout
    • Events
      • Show All Events
      • Filter Events
    • Learning Paths
      • Show Learning Paths
      • Filter Learning Paths
    • Widgets
      • Widgets Introduction
      • Catalog Widget
      • Cart Widget
      • Analytics
    • API Reference
    • Upcoming API Changes
  • Legacy API
    • Introduction
    • Authorization
    • Behaviour
      • Version 2.5 (v2.5)
      • Version 2 (v2)
    • CRM
      • Accounts
      • Contacts
      • Enquiries
      • Form Submissions
      • Marketing Activities
      • Marketing Campaigns
      • Marketing Lists
      • Opportunities
      • Opportunity Steps
      • Source Types
      • Tasks
    • Custom Fields
      • Field Definitions
      • Reading
      • Writing
    • Documents
      • Course Details
      • Getting DMS Documents
      • Evaluation Forms
      • Event Details
      • Getting Invoices by Account
      • Payment Receipts
    • Events
      • Venues
      • Categories
      • Courses
      • Delegates
      • Event Personnel
      • Event Prices
      • Learning Tracks
      • Private Events
      • Public Events
      • Registrations
      • Sub Categories
      • Tags
      • Locations
    • Financials
      • Currencies
      • Discounts
      • Invoices
      • Sales Invoices (Deprecated)
      • Tax Types
    • Orders
      • Create an Order
      • Deleting Orders
      • Unnamed Delegates
    • Stock
      • Items
    • System
      • Document Templates
      • Regions
      • Users
    • Time zones
      • Valid Time Zones
    • API Reference
    • Upcoming API Changes
  • Resources
    • Introduction to GraphQL
    • Authorization
    • Webhooks
    • Legacy API
  • Blog
  • Main SiteSystem StatusSecurity Overview

Learn

Introduction Authorization
Behaviour
Version 2.5 (v2.5) Version 2 (v2)
CRM
Accounts Contacts Enquiries Form Submissions Marketing Activities Marketing Campaigns Marketing Lists Opportunities Opportunity Steps Source Types Tasks
Custom Fields
Field Definitions Reading Writing
Documents
Course Details Getting DMS Documents Evaluation Forms Event Details Getting Invoices by Account Payment Receipts
Events
Venues Categories Courses Delegates Event Personnel Event Prices Learning Tracks Private Events Public Events Registrations Sub Categories Tags Locations
Financials
Currencies Discounts Invoices Sales Invoices (Deprecated) Tax Types
Orders
Create an Order Deleting Orders Unnamed Delegates
Stock
Items
System
Document Templates Regions Users
Time zones
Valid Time Zones

Release Notes

Introduction

The pages in this section document our older legacy REST API. This is not under active development and will be phased out in the future

We recommend any integrations to be built on our actively developed GraphQL APIs which are documented in this portal.

Variables
Results
©2025 Administrate Limited. All rights reserved.
Main Site • System Status • Security Overview