Jump to Content
JRNI Developer DocumentationHomeJRNI Help GuidesJRNI Release NotesJRNI Website
HomeJRNI DocsTutorialsREST API
HomeJRNI Help GuidesJRNI Release NotesJRNI WebsiteLog InJRNI Developer Documentation
REST API
Log In
HomeJRNI DocsTutorialsREST API

JRNI API GUIDE

  • Introduction
    • Account Set up
    • Request Headers
    • Date and Time formats
    • Pagination
  • Authentication
    • Authentication types
    • Supported Authentication Methods
    • Basic Authentication
    • OAuth 2.0
    • Single Sign On
    • Auth Token Expiry
    • Public API Basket Authentication
  • Permissions
    • Public
    • Admin
    • Member
  • JRNI Data Models
    • Company configuration
    • People configuration
  • Errors
    • 301 Moved Permanently
    • 400 Validation Error
    • 401 Unauthorized Error
    • 403 Forbidden Error
    • 403 Rescheduling a booking that exceeds minimum cancel time error
    • 403 Rescheduling cancelled booking error
    • 403 Rescheduling external booking error
    • 404 Not Found Error
    • 404 Bad URL Error
    • 405 Method Not Allowed Error
    • 409 Conflict Error
    • 415 Unsupported Media Type Error
  • Data Webhooks
    • Authentication (data webhooks)
    • Data Webook Payload
    • Webhook Field definitions
  • Notification Webhooks

Public API

  • Public API
  • Service
    • Service Readget
    • Service Find By Referenceget
    • List Servicesget
  • Resource
    • Get Resourceget
    • Resource Find By Referenceget
    • List Resourcesget
  • Company
    • Find Company By Referenceget
    • Company Searchget
    • List Child Companiesget
    • Get Companyget
  • Event
    • Get Eventget
    • List Eventsget
  • Event Group
    • Get Event Groupget
    • EventGroup Find By Referenceget
    • List Event Groupsget
  • Event Chain
    • Get Event Chainget
    • List Event Chainsget
  • Question
    • Get Questionget
    • Get Question Groupget
    • List Survey Questionget
  • Category
    • Get Categoryget
    • List Categoriesget
    • List Named Categoriesget
  • Client
    • Client Readget
    • Update Clientput
    • Create Clientpost
  • Booking Text
    • List Booking Textget
  • Address
    • Search Addresspost
    • Get Addressget
    • List Addressesget
  • Image
    • Get Imageget
    • List Imagesget
    • Get Event Group Imageget
    • List Event Group Imagesget
  • Package
    • Get Packageget
    • List Packagesget
  • Bulk Purchase
    • Get Bulk Purchaseget
    • List Bulk Purchasesget
  • Booking
    • Create Bookingpost
  • Terminology
    • Terminology Readget
  • Event Landing Page
    • Fetch Event Landing Pageget
  • Event Detail
    • Fetch Event Detailget
  • Person
    • Find Person By Reference IDget
    • Get Personget
    • List Peopleget
  • Time
    • /{company_id}/times/{datetime}get
    • List Timesget
    • List Datesget
  • Opening Hours
    • Company Opening Hoursget
  • Company Text
    • Company text configurations readget

Admin API

  • Admin API
  • Client
    • Client Searchpost
    • Search for a memberget
    • Get Clientget
    • Update Clientput
    • Delete Clientdelete
    • List Clientsget
    • Create Clientpost
    • Find Client By Emailget
    • Find Client By Referenceget
    • Edit Client (Schema)get
    • New Client (Schema)get
  • Booking
    • Booking Searchpost
    • List notes of the Bookingget
    • Add note to Bookingpost
    • Get a note of the Bookingget
    • Cancel Bookingpost
    • Get Bookingget
    • Update Bookingput
    • List Bookingsget
    • Create Bookingpost
    • Edit Booking (Schema)get
    • Obtains Attendees of Bookingget
    • Add Attendees To Bookingpost
    • Modify Attendeeput
    • Remove Attendeedelete
  • Image
    • Get Image Linkget
    • Delete Image Linkdelete
    • List Image Linksget
    • Create Imagepost
    • Get Imageget
    • Delete Imagedelete
    • List Imagesget
    • Get Image Linkget
    • Delete Image Linkdelete
    • List Image Linksget
    • Create Imagepost
  • Time
    • List Datesget
    • /admin/{company_id}/times/{datetime}get
    • List Timesget
  • Person
    • Search for a personget
    • Search for a person able to be used in a booking at the current companyget
    • Get Person Companiesget
    • Update Person Companiespatch
    • Get Personget
    • Update Personput
    • Delete Persondelete
    • Create Person Blockput
    • List Peopleget
    • Create Personpost
    • Find Person By Referenceget
    • Edit Person (Schema)get
    • New Person (Schema)get
  • Sequence
    • Get sequenceget
    • Update sequenceput
    • Edit Sequenceget
  • Address
    • Get Addressget
    • Update Addressput
    • Delete Addressdelete
    • List Addressesget
    • Create Addresspost
    • Edit Address (Schema)get
    • New Address (Schema)get
  • Company
    • Get Companyget
    • Update Companyput
    • Delete Companydelete
    • Find Company by referenceget
    • Company Searchget
    • Company Editget
    • List Child Companiesget
    • Create Child Companypost
    • Update A companies logoput
  • Notification Preference
    • Update Company Notification Preference Settingput
  • Queue Setting
    • Edit Queue Setting (Schema)get
    • Queue Setting (Schema)get
    • Update Queue Settingput
  • Service
    • Get Serviceget
    • Update Serviceput
    • Delete Servicedelete
    • New Service Booking (Schema)get
    • List Servicesget
    • Create Servicepost
    • Find Service By Referenceget
    • Edit Service (Schema)get
    • New Service (Schema)get
  • Resource
    • Get Resourceget
    • Update Resourceput
    • Resource Deletedelete
    • Create Resource Blockput
    • List Resourcesget
    • Create Resourcepost
    • Edit Resourceget
    • New Resource (Schema)get
  • Slot
    • Get Slotget
    • Update Slotput
    • Delete (Cancel) Slotdelete
    • List Slotget
    • Create Slotpost
    • Update Eventput
  • Purchase
    • Find Purchase By Referenceget
    • Get Purchaseget
    • Update Purchaseput
    • List Purchasesget
    • List Purchase Paymentsget
    • Pay Purchaseput
  • Administrator
    • Get Administratorget
    • Update Administratorput
    • Delete Administratordelete
    • List Administratorsget
    • Create Administratorpost
    • Get Administrator by referenceget
    • Edit (Schema)get
    • New (Schema)get
  • Schedule
    • Get Scheduleget
    • Update Scheduleput
    • Delete Scheduledelete
    • List Schedulesget
    • Create Schedulepost
    • Edit Scheduleget
    • New Schedule (Schema)get
    • Get Shift Patternget
    • Update Shift Patternput
    • Delete Shift Patterndelete
    • List Shift Patternget
    • Create Shift Patternpost
    • Shift Listget
    • Update Shift Collectionput
    • Get Shiftget
    • Update Shiftput
    • Delete Shiftdelete
    • Get Shift Pattern Conditionget
    • Update Shift Pattern Conditionput
    • Delete Shift Pattern Conditiondelete
    • List Shift Pattern Conditionget
    • Create Shift Pattern Conditionpost
    • Edit Schedule Condition (Schema)get
    • New Shift Pattern Condition (Schema)get
  • Event Chain
    • Get Event Chainget
    • Update Event Chainput
    • Delete Event Chaindelete
    • New Booking (Schema)get
    • List Event Chainsget
    • Create Event Chainpost
    • Get Event Chain By Reference IDget
    • Edit Event Chain (Schema)get
    • New Event Chain (Schema)get
  • Event Group
    • Get Event Groupget
    • Update Event Groupput
    • Delete Event Groupdelete
    • List Event Groupsget
    • Create Event Grouppost
    • Find Event Group By Referenceget
    • Edit Event Group (Schema)get
    • New Event Group (Schema)get
  • Calendar Event
    • Get Calendar Eventget
    • List Calendar Eventsget
  • Pre Paid Booking
    • /admin/{company_id}/pre_paid_bookings/{id}get
    • /admin/{company_id}/pre_paid_bookings/{id}put
    • /admin/{company_id}/pre_paid_bookings/{id}delete
    • /admin/{company_id}/pre_paid_bookingsget
    • /admin/{company_id}/pre_paid_bookings/{pre_paid_booking_id}/spaces/{id}delete
  • Bulk Purchase
    • Get Bulk Purchaseget
    • List Bulk Purchasesget
  • Opening Hours
    • Company Opening Hoursget
    • Update Company Opening Hoursput
    • Edit Opening Hours (Schema)get
  • Communication
    • Send Communicationpost
  • Reason
    • List Reasonsget
    • Create Reasonpost
    • New Reasonget
    • Get Reasonget
    • Update Reasonput
    • Delete Reasondelete
    • Edit Reasonget
  • Question Group
    • List Question Groupsget
    • Create Question Grouppost
    • New Question Groupget
    • Get Question Groupget
    • Update Question Groupput
    • Delete Question Groupdelete
    • Edit Question Groupget
  • Company Text
    • Company text configurations readget
    • Company text configurations updateput
    • Company text configurations deletedelete
    • Company text configurations read collectionget
    • Company text configurations createpost
    • Company text configurations edit schema formget
    • Company text configurations new schema formget
  • admin
    • /admin/{company_id}/events/{session_id}/landing_pageput
    • /admin/{company_id}/events/{session_id}/landing_pagepost
  • Company Closures
    • List Company Closures (Including Inherited)get
    • Create Company Closurepost
    • Update Company Closureput
    • Delete Company Closuredelete
  • Company Closure Exclusions
    • List Company Closure Exclusionsget
    • Create Company Closure Exclusionpost
    • Delete Company Closure Exclusiondelete
  • Event
    • Event Readget
    • New Booking (Schema)get
    • List Eventsget
    • Edit Event (Schema)get
    • New Event (Schema)get
  • Event Landing Page
    • Event Landing Page Configurationget

Login API

  • Login API
  • Login
    • Loginpost
    • Admin Loginpost
    • Company Admin Loginpost

Baskets API

  • Basket API
  • Basket
    • Retrieve all basketsget
    • Create A Basketpost
    • Clears all baskets on your tokendelete
    • Basket Checkoutpost
    • Refreshes your lock on all held itemsput
    • Get Basketget
    • Delete basketdelete
  • Basket Service Item
    • Creates a Service Itempost
    • Read Basket Itemget
    • Updates a Service Itemput
    • Delete Basket Itemdelete
  • Basket Attachment
    • Get an attachment of the basket itemget
    • Remove attachment from the basket itemdelete
    • List attachments of the basket itemget
    • Add an attachment to basket itempost
  • Basket Service Item Attendee
    • Obtains Attendees of Bookingget
    • Add Attendees To Bookingpost
    • Modify Attendeeput
    • Remove Attendeedelete

Basket API [deprecated]

  • Basket
    • Get an Attachment from the Basketget
    • Delete Attachment from the Basketdelete
    • Update File Attachment for Basketput
    • Add Attachment to Basketpost
    • Obtains Attendees of Bookingget
    • Add Attendees To Bookingpost
    • Modify Attendeeput
    • Remove Attendeedelete
    • Read Basket Itemget
    • Delete Basket Itemdelete
    • Read Basketget
    • Destroy Basketdelete
    • Checkout Basketpost
    • Create Basket Itempost

Member API

  • Member API
  • Member
    • Send Member welcome emailpost
    • Member Readget
    • Update Memberput
    • Edit Memberget
  • Member Booking
    • Obtains Attendees of Bookingget
    • Add Attendees To Bookingpost
    • Modify Attendeeput
    • Remove Attendeedelete
    • Edit Bookingget
    • Booking Readget
    • Booking Updateput
    • Cancel Bookingdelete
    • Booking Listget
    • Booking Rescheduleput
  • Member Purchase Total
    • Purchase Total Paymentsget
    • Purchase Total Readget
    • Purchasesget
  • Member Wallet
    • Wallet Purchase Band Readget
    • Wallet Purchase Bandsget
    • Wallet Logs Readget
    • Wallet Log Readget
    • Wallet Readget
    • Update Walletput
    • /{company_id}/members/{member_id}/walletpost
  • Member Pre Paid Booking
    • Pre Paid Booking Readget
    • Pre Paid Booking Listget

Purchase API

  • Purchase API
  • Purchase
    • Delete (Cancel) All Bookings associated with a given Purchasedelete
    • Purchase Readget
    • Obtains Attendees of Bookingget
    • Add Attendees To Bookingpost
    • Modify Attendeeput
    • Remove Attendeedelete
  • Booking
    • /purchases/{purchase_id}/bookings/{id}get
    • /purchases/{purchase_id}/bookings/{id}put
    • /purchases/{purchase_id}/bookings/{id}delete
    • /purchases/{purchase_id}/bookings/{id}/confirmput

Import API

  • Import API
  • Import
    • Import Organisation Asyncronouslypost
    • Lists Import Jobsget
    • Import Organisationpost
    • List Import Job Itemsget
    • List Import Job Itemsget
    • Read Import Jobget

Purchase API

OpenAPI Schema