Jump to Content
Guides
API Reference
Flex
Hybrid
Flex v2
officernd.com
Support
Admin Portal
Become a Partner
Log In
API Reference
Search
officernd.com
Support
Admin Portal
Become a Partner
Log In
Flex v2
Guides
API Reference
Contracts
All
Pages
Start typing to search…
JUMP TO
Authentication API
Token generation
Generate an OAuth 2.0 token
post
Community API
Members
Get members
get
Add new member
post
Get members count by filter
get
Get member
get
Update member
put
Delete member
del
Manage member portal access
put
Companies
Get companies
get
Add new company
post
Get company
get
Update company
put
Delete company
del
Visits
Get visits
get
Add new visit
post
Get visit
get
Delete visit
del
Visitors
Get visitors
get
Add new visitor
post
Get visitor
get
Delete visitor
del
Opportunities
Get opportunities
get
Add new opportunity
post
Get opportunities count
get
Get opportunity
get
Update opportunity
put
Delete opportunity
del
Opportunity Statuses
Retrieve all opportunity statuses
get
Contracts
Checkins
Retrieve all check-ins.
get
Retrieve all visitor check-ins.
get
Retrieve a single Check-In
get
Check in a Member
post
Check Out a Member
post
Fees
Get a list of fees
get
Add a new fee
post
Get fees count
get
Get a single fee
get
Update and existing fee
put
Delete a single fee
del
Memberships
Get a list of memberships
get
Add a new membership
post
Get memberships count
get
Get a single membership
get
Update an existing membership
put
Delete a single membership
del
Reception Flows
Get reception flows
get
Contracts
Retrieve all contracts.
get
Add new contract
post
Get contracts count by filter
get
Get contract
get
Delete contract
del
Sign a contract
post
Terminate a contract
post
Space API
Locations
Retrieve all locations.
get
Retrieve single location.
get
Floors
Retrieve all floors
get
Gets a specific floor
get
Resources
Retrieve all resources.
get
Get resources count
get
Retrieve single resource.
get
Get resource status
get
Resource Types
Get resource types
get
Assignments
Retrieve all assignments for a specific resource
get
Create an assignment
post
Delete an assignment
del
Amenities
Retrieve all amenities
get
Get an amenity
get
Bookings
Retrieve all booking series and one-off bookings.
get
Add new booking
post
Get bookings count
get
Retrieve all booking occurrences (expanded instances).
get
Validate a booking.
post
Retrieve single booking.
get
Update existing booking
put
Delete booking
del
Cancel a booking that was already confirmed.
post
Passes
Get sets of day passes
get
Add a new set of day passes
post
Get a set of day passes
get
Update a set of day passes
put
Delete a set of day passes
del
Credits
Retrieve all credits.
get
Create a new set of credits.
post
Retrieve single set of credits.
get
Update an existing set of credits.
put
Delete a set of credits.
del
Coins
Get the coin credit balance for a company/member in a specific month.
get
Collaboration API
Tickets
Get tickets
get
Add a new ticket
post
Get tickets count by filter
get
Get ticket
get
Update an existing ticket
put
Ticket Options
Get ticket options
get
Ticket Comments
Retrieve all comments for a ticket
get
Post a comment/comments about a specific ticket
post
Posts
Retrieve all posts
get
Add a new post
post
Gets a post
get
Delete a post
del
Events
Retrieve all events.
get
Create a new event.
post
Get events count
get
Retrieve single event.
get
Update an existing event.
put
Delete an event.
del
Benefits
Get benefits
get
Get benefits count by filter
get
Get benefit
get
Billing & Product API
Payments
Retrieve all payments
get
Create a new overpayment
post
Retrieve the payments count
get
Retrieve all payment methods
get
Get payment by id
get
Update payment
put
Get all documents associated with the specific invoice
get
Update allocation accounting
put
Create a new allocation for credit note/overpayment
post
Charges
Retrieve all charges
get
Create a new charge for invoice
post
Update a charge for invoice
put
Delete a charge for invoice
del
Tax Rates
Retrieve all tax rates.
get
Get single tax rate.
get
Revenue Accounts
Retrieve all revenue accounts.
get
Get single revenue account.
get
Plans
Get plans
get
Get plans count by filter
get
Get plan
get
Resource Rates
Retrieve all resource rates.
get
Get resource rates count
get
Retrieve single resource rate.
get
Payment Details
Get payment details for user
get
Add new payment details for user
post
Delete payment details by id
del
Payment Gateways
Authorize payment or setup intent
post
Checkout
Get checkout cost preview
post
Execute checkout
post
Settings API
Webhooks
Get a list of webhooks
get
Add a new webhook
post
Get a single webhook
get
Update an existing webhook
put
Delete a single webhook
del
Custom Properties
Retrieve all custom properties
get
Secondary Currencies
Retrieve all secondary currencies
get
Get a specific secondary currency
get
Update a secondary currency
put
Billing Settings
Retrieve billing settings.
get
Integrations
Get a single integration
get
Business Hours
Retrieve business hours.
get
Organizations
Get the current organization information
get
User API
Auth
Create a user
post
Sign in a user
post
Impersonate a member
post
Validate JWT token
post
Password
Reset password
post
Change password
put
Powered by
Contracts
Ask AI
