Jump to Content
Home
JRNI Help Guides
JRNI Release Notes
JRNI Website
Home
JRNI Docs
Tutorials
REST API
v5.0
Home
JRNI Help Guides
JRNI Release Notes
JRNI Website
Log In
REST API
Log In
v5.0
Home
JRNI Docs
Tutorials
REST API
Purchase API
Search
JUMP TO
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 Read
get
Service Find By Reference
get
List Services
get
Resource
Get Resource
get
Resource Find By Reference
get
List Resources
get
Company
Find Company By Reference
get
Company Search
get
List Child Companies
get
Get Company
get
Event
Get Event
get
List Events
get
Event Group
Get Event Group
get
EventGroup Find By Reference
get
List Event Groups
get
Event Chain
Get Event Chain
get
List Event Chains
get
Question
Get Question
get
Get Question Group
get
List Survey Question
get
Category
Get Category
get
List Categories
get
List Named Categories
get
Client
Client Read
get
Update Client
put
Create Client
post
Booking Text
List Booking Text
get
Address
Search Address
post
Get Address
get
List Addresses
get
Image
Get Image
get
List Images
get
Get Event Group Image
get
List Event Group Images
get
Package
Get Package
get
List Packages
get
Bulk Purchase
Get Bulk Purchase
get
List Bulk Purchases
get
Booking
Create Booking
post
Terminology
Terminology Read
get
Event Landing Page
Fetch Event Landing Page
get
Event Detail
Fetch Event Detail
get
Person
Find Person By Reference ID
get
Get Person
get
List People
get
Time
/{company_id}/times/{datetime}
get
List Times
get
List Dates
get
Opening Hours
Company Opening Hours
get
Company Text
Company text configurations read
get
Admin API
Admin API
Client
Client Search
post
Search for a member
get
Get Client
get
Update Client
put
Delete Client
delete
List Clients
get
Create Client
post
Find Client By Email
get
Find Client By Reference
get
Edit Client (Schema)
get
New Client (Schema)
get
Booking
Booking Search
post
List notes of the Booking
get
Add note to Booking
post
Get a note of the Booking
get
Cancel Booking
post
Get Booking
get
Update Booking
put
List Bookings
get
Create Booking
post
Edit Booking (Schema)
get
Obtains Attendees of Booking
get
Add Attendees To Booking
post
Modify Attendee
put
Remove Attendee
delete
Image
Get Image Link
get
Delete Image Link
delete
List Image Links
get
Create Image
post
Get Image
get
Delete Image
delete
List Images
get
Get Image Link
get
Delete Image Link
delete
List Image Links
get
Create Image
post
Time
List Dates
get
/admin/{company_id}/times/{datetime}
get
List Times
get
Person
Search for a person
get
Search for a person able to be used in a booking at the current company
get
Get Person Companies
get
Update Person Companies
patch
Get Person
get
Update Person
put
Delete Person
delete
Create Person Block
put
List People
get
Create Person
post
Find Person By Reference
get
Edit Person (Schema)
get
New Person (Schema)
get
Sequence
Get sequence
get
Update sequence
put
Edit Sequence
get
Address
Get Address
get
Update Address
put
Delete Address
delete
List Addresses
get
Create Address
post
Edit Address (Schema)
get
New Address (Schema)
get
Company
Get Company
get
Update Company
put
Delete Company
delete
Find Company by reference
get
Company Search
get
Company Edit
get
List Child Companies
get
Create Child Company
post
Update A companies logo
put
Notification Preference
Update Company Notification Preference Setting
put
Queue Setting
Edit Queue Setting (Schema)
get
Queue Setting (Schema)
get
Update Queue Setting
put
Service
Get Service
get
Update Service
put
Delete Service
delete
New Service Booking (Schema)
get
List Services
get
Create Service
post
Find Service By Reference
get
Edit Service (Schema)
get
New Service (Schema)
get
Resource
Get Resource
get
Update Resource
put
Resource Delete
delete
Create Resource Block
put
List Resources
get
Create Resource
post
Edit Resource
get
New Resource (Schema)
get
Slot
Get Slot
get
Update Slot
put
Delete (Cancel) Slot
delete
List Slot
get
Create Slot
post
Update Event
put
Purchase
Find Purchase By Reference
get
Get Purchase
get
Update Purchase
put
List Purchases
get
List Purchase Payments
get
Pay Purchase
put
Administrator
Get Administrator
get
Update Administrator
put
Delete Administrator
delete
List Administrators
get
Create Administrator
post
Get Administrator by reference
get
Edit (Schema)
get
New (Schema)
get
Schedule
Get Schedule
get
Update Schedule
put
Delete Schedule
delete
List Schedules
get
Create Schedule
post
Edit Schedule
get
New Schedule (Schema)
get
Get Shift Pattern
get
Update Shift Pattern
put
Delete Shift Pattern
delete
List Shift Pattern
get
Create Shift Pattern
post
Shift List
get
Update Shift Collection
put
Get Shift
get
Update Shift
put
Delete Shift
delete
Get Shift Pattern Condition
get
Update Shift Pattern Condition
put
Delete Shift Pattern Condition
delete
List Shift Pattern Condition
get
Create Shift Pattern Condition
post
Edit Schedule Condition (Schema)
get
New Shift Pattern Condition (Schema)
get
Event Chain
Get Event Chain
get
Update Event Chain
put
Delete Event Chain
delete
New Booking (Schema)
get
List Event Chains
get
Create Event Chain
post
Get Event Chain By Reference ID
get
Edit Event Chain (Schema)
get
New Event Chain (Schema)
get
Event Group
Get Event Group
get
Update Event Group
put
Delete Event Group
delete
List Event Groups
get
Create Event Group
post
Find Event Group By Reference
get
Edit Event Group (Schema)
get
New Event Group (Schema)
get
Calendar Event
Get Calendar Event
get
List Calendar Events
get
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_bookings
get
/admin/{company_id}/pre_paid_bookings/{pre_paid_booking_id}/spaces/{id}
delete
Bulk Purchase
Get Bulk Purchase
get
List Bulk Purchases
get
Opening Hours
Company Opening Hours
get
Update Company Opening Hours
put
Edit Opening Hours (Schema)
get
Communication
Send Communication
post
Reason
List Reasons
get
Create Reason
post
New Reason
get
Get Reason
get
Update Reason
put
Delete Reason
delete
Edit Reason
get
Question Group
List Question Groups
get
Create Question Group
post
New Question Group
get
Get Question Group
get
Update Question Group
put
Delete Question Group
delete
Edit Question Group
get
Company Text
Company text configurations read
get
Company text configurations update
put
Company text configurations delete
delete
Company text configurations read collection
get
Company text configurations create
post
Company text configurations edit schema form
get
Company text configurations new schema form
get
admin
/admin/{company_id}/events/{session_id}/landing_page
put
/admin/{company_id}/events/{session_id}/landing_page
post
Company Closures
List Company Closures (Including Inherited)
get
Create Company Closure
post
Update Company Closure
put
Delete Company Closure
delete
Company Closure Exclusions
List Company Closure Exclusions
get
Create Company Closure Exclusion
post
Delete Company Closure Exclusion
delete
Event
Event Read
get
New Booking (Schema)
get
List Events
get
Edit Event (Schema)
get
New Event (Schema)
get
Event Landing Page
Event Landing Page Configuration
get
Login API
Login API
Login
Login
post
Admin Login
post
Company Admin Login
post
Baskets API
Basket API
Basket
Retrieve all baskets
get
Create A Basket
post
Clears all baskets on your token
delete
Basket Checkout
post
Refreshes your lock on all held items
put
Get Basket
get
Delete basket
delete
Basket Service Item
Creates a Service Item
post
Read Basket Item
get
Updates a Service Item
put
Delete Basket Item
delete
Basket Attachment
Get an attachment of the basket item
get
Remove attachment from the basket item
delete
List attachments of the basket item
get
Add an attachment to basket item
post
Basket Service Item Attendee
Obtains Attendees of Booking
get
Add Attendees To Booking
post
Modify Attendee
put
Remove Attendee
delete
Basket API [deprecated]
Basket
Get an Attachment from the Basket
get
Delete Attachment from the Basket
delete
Update File Attachment for Basket
put
Add Attachment to Basket
post
Obtains Attendees of Booking
get
Add Attendees To Booking
post
Modify Attendee
put
Remove Attendee
delete
Read Basket Item
get
Delete Basket Item
delete
Read Basket
get
Destroy Basket
delete
Checkout Basket
post
Create Basket Item
post
Member API
Member API
Member
Send Member welcome email
post
Member Read
get
Update Member
put
Edit Member
get
Member Booking
Obtains Attendees of Booking
get
Add Attendees To Booking
post
Modify Attendee
put
Remove Attendee
delete
Edit Booking
get
Booking Read
get
Booking Update
put
Cancel Booking
delete
Booking List
get
Booking Reschedule
put
Member Purchase Total
Purchase Total Payments
get
Purchase Total Read
get
Purchases
get
Member Wallet
Wallet Purchase Band Read
get
Wallet Purchase Bands
get
Wallet Logs Read
get
Wallet Log Read
get
Wallet Read
get
Update Wallet
put
/{company_id}/members/{member_id}/wallet
post
Member Pre Paid Booking
Pre Paid Booking Read
get
Pre Paid Booking List
get
Purchase API
Purchase API
Purchase
Delete (Cancel) All Bookings associated with a given Purchase
delete
Purchase Read
get
Obtains Attendees of Booking
get
Add Attendees To Booking
post
Modify Attendee
put
Remove Attendee
delete
Booking
/purchases/{purchase_id}/bookings/{id}
get
/purchases/{purchase_id}/bookings/{id}
put
/purchases/{purchase_id}/bookings/{id}
delete
/purchases/{purchase_id}/bookings/{id}/confirm
put
Import API
Import API
Import
Import Organisation Asyncronously
post
Lists Import Jobs
get
Import Organisation
post
List Import Job Items
get
List Import Job Items
get
Read Import Job
get
Purchase API
OpenAPI Schema
