Cookies help us deliver our services. By using our services, you agree to our use of cookies.

API Changes

You can subscribe to the atom change feed too.
2023-06-28

Added title attribute for event bookings (the event title is used).

2023-04-27

Allowed members to check themselves in and out via POST memberships/:membership_id/work_sessions and DELETE memberships/:membership_id/check_ins/current

2022-08-01

Added total_amount and amount_remaining attributes to booking credits.

2022-07-22

Added updating the admin name.

2022-07-14

Added channels attribute to activities.

2021-04-22

Added has_custom_price attribute to bookings to indicate that a fixed price has been set

2020-11-30

Added event attribute containing the id to bookings if they belong to an event

2020-11-19

Changed PUT & DELETE /bookings/:booking_id can respond with 409 when the booking has an event.

2020-10-21

Added .zip format support to GET /api/invoices endpoint

2020-03-02

Added updated_at & created_at to bookings

2019-08-13

Added updating navigation links.

2019-07-03

Added stripe_payment_method_id which is the id of the payment method used by Stripe for a given customer

2019-06-21

Added units to bookings to allow to book more than one unit at once

2019-06-20

Added can_charge to invoices.

2019-04-24

Added accounting_code to bookings.

2019-04-10

Added color and photo to plans.

2019-04-01

Redirect URI is required for new OAuth clients.

2019-03-07

Added preview param to credentials check-in endpoint.

2019-02-27

Added support for OpenID Connect.

2019-02-14

Added support for Gocardless to update membership payment method endpoint.

2018-11-23

Added space logo endpoint.

2018-10-18

Added total_amount, total_amount_with_taxes, total_tax_amount to invoice items.

2018-10-16

Added tax_amount to invoice items.

2018-10-01

Added uncanceled_membership webhook.

2018-09-18

Added validate_times_for_admin param to booking endpoints.

2018-09-10

Added minimum_commitment to plan endpoints

2018-09-03

Added create/delete guest account endpoints.

2018-07-18

Added taxes to invoices. Deprecated tax_amounts, tax_rate.

2018-06-26

Added confirmation_date/first_invoice_date to confirm membership endpoint. Added default_invoice_day and next_default_invoice_date to invoice_settings endpoint.

2018-06-21

Removed user photo endpoints. Users don't have photos anymore. User photo attributes now return a placeholder.

2018-06-08

Added payment method attributes to payment records.

2018-03-26

Added rate limiting the API (60 rpm per user, 6 rpm for member list).

2018-03-19

Added time to guest account expires_at attribute.

2018-03-16

Added /service_charges endpoint. Added /membership/bookings endpoint to get a list of own bookings as member.

2018-02-19

Added /email_customizations endpoint.

2018-02-09

Added cancel own membership endpoint.

2018-01-10

Added invoices search. Added membership_reactivated webhook.

2018-01-03

Added /space/custom_fields endpoints for accessing space level custom fields.

2017-12-15

Added fetching invoices by ids.

2017-11-22

Added creating access tokens for a space.

2017-11-21

Added passing ids to /resources.

2017-11-15

Added limit parameter to /bookings endpoint.

2017-11-14

Added /accounting_codes endpoint.

2017-11-13

Added checkin token data to deleted_checkin_token webhook event.

2017-11-08

Added photo attribute to /resources endpoints.

2017-10-20

Added price_decimals attribute to GET /spaces endpoints.

2017-10-11

Added charge_at and due_date to GET api/*/invoices endpoints

2017-09-24

Added setting price when creating/updating a booking.

2017-09-23

Added locale to spaces.

2017-09-19

Added expires_at to POST api/memberships/:membership_id/time_passes. Added weekdays to booking_times in /resources endpoint.

2017-09-13

Added endpoint for fetching bookings by membership id and timespan. Added endpoint for updating time passes.

2017-09-07

Added return_payment_errors query param to invoice charges endpoint.

2017-08-29

Added generate_invoices_days_early attribute to invoice settings endpoint.

2017-08-10

Added sending valid_from when checking member in.

2017-07-24

Added tax_rate to resources.

2017-07-17

Added parsed_timespans attribute to time passes endpoints.

2017-07-11

Added HTML format to /activities endpoint.

2016-06-26

Added updated_membership_picture webhook.

2017-06-23

Added booking data to delete_booking webhook, as it's impossible to fetch it after deletion.

2017-06-21

Added endpoint for getting bookings of a resource in a certain timspan.

2017-06-12

Added membership_cancellation_date_reached webhook.

2017-05-30

Added /invoice_settings endpoint.

2017-05-18

Added endpoint for deleting an invoice.

2017-05-15

Added endpoint for reopening a written off invoice.

2017-05-02

Added total_paid_amount to invoices.

2017-04-13

Added id to activities.

2017-04-10

Added endpoint for retrieving list of unused time passes as member.

2017-03-22

Added user_editable to navigation links.

2017-03-20

Added prorate_first_invoice attribute to membership creation endpoint.

2017-03-08

Added endpoint for generating membership invites.

2017-03-07

Added POST /api/password_resets to trigger password reset emails by API

2016-12-22

Added updated_membership_details webhook.

2016-12-15

Removed membership id from endpoints for showing/deleting a time pass.

2016-12-08

Added time_pass attribute to check-ins.

2016-11-14

Made invoice endpoints work with invoice ids in addition to invoice numbers (using ids is now preferred).

2016-11-10

Added updated_connected_user webhook.

2016-11-08

Added passing time pass name when checking in member. Added guest accounts endpoints. Added admin/guest account webhooks.

2016-10-10

Added signup_charge to plans. Added endpoints for customizing members' plans.

2016-10-05

Added updated_custom_field webhook.

2016-09-24

Added booking_times attribute to resources.

2016-09-23

Added list of past member plans via GET /memberships/:membership_id/plans

2016-09-14

Added included_value/included_unit to booking credits. included_unit is either 'hours' or 'amount'. These replace the hours attribute, which is now deprecated.

2016-09-12

Added deleting memberships.

2016-09-08

Added listing and creating help desk issues

2016-08-30

Added setting invoice status to written_off

2016-08-17

Added listing activities by source ids. Added customer_number to invoices.

2016-08-15

Added tax_id_name/tax_id to invoices.

2016-08-11

Added adding and removing team members

2016-07-25

Added listing check-ins of single members for admin (GET /api/memberships/:membership_id/check_ins).

2016-07-22

Limits max. date range when requesting bookings to 6 months.

2016-06-13

Added email, billing_email and paying_membership_id fields to create membership endpoint.

2016-06-20

Added checkin token webhooks and GET /check_in_tokens/:token endpoint.

2016-06-17

Added requested_starts_at parameter to api/memberships POST body to set a start date for the membership. Added pre_approved parameter to api/memberships POST body to indicate a membership does not need confirmation.

2016-06-08

Added read_subscriptions/write_subscriptions scopes for subscriptions API. Added accounting codes to plans.

2016-06-01

Added /api/memberships/:membership_id/user to space api to connect a user to a membership

2016-03-31

Added paid_at date in /api/invoices/*

2016-03-23

Added amount_with_tax to invoice items in /api/invoices/*

2016-03-21

Added endpoints for managing resources.

2016-03-18

parent_plan will now tell you the id of the /api/plans that was used as template to create a membership plan in api/memberships/.Added reading of booking_credits of the plan to api/plans/ and api/memberships/*.

2016-02-10

Added tax_name to /api/invoices/*

2016-02-09

Fixed return company name as name in /api/memberships/* if name not set

2015-12-03

use same serialization for the plan part at /api/membership endpoint then /api/plans and include tax_rate. Removed deprecated day_pass_price_in_cents, max_days_per_timespan max_days_timespan from membership.plan

2015-11-23

Added check-out webhook.

2015-11-05

Added listing memberships by id.

2015-11-04

Added can_book attribute to booking calendar resources.

2015-11-03

Added booking categories endpoint.

2015-10-26

Added booking passes endpoints.

2015-09-29

Added tax_rate to plan. Added customer_number and charge_taxes field to membership responses.

2015-09-23

Added tax_rate to one time charges endpoints

2015-09-22

Added address details like name, company and country to /api/answers

2015-09-14

Added color attribute to resources.

2015-09-09

Added PUT /api/membership/plan so that members can change their plan. Added PUT /api/memberships/:membership_id & /api/membership for updating membership details. Added hd image size (1200x1200), added uploading base64 encoded pictures.

2015-08-19

Added updating user/member picture.

2015-08-12

Added member names to check-ins. Added listing check-ins for a space as member (GET /api/check-ins). Added writing custom fields.

2015-08-11

Added POST /api/membership so allow current user to signup for a membership. Added /api/membership so get membership of current user. Added /api/answers to get all answers of members for questionnaire. Added /membership/answers so members can change their questionnaires.

2015-08-05

Added revoke access token endpoint. Added username/password authentication for native apps.

2015-06-10

Members can now create custom invoices for themselves, charge and send them. Added already_paid attribute to charges.

2015-06-03

Added /payment_records?from=YYYY-MM-DD&to=YYYY-MM-DD endpoint to query payment records by paid at

2015-06-01

Added price_per_cycle, extras[].price, extras[].currency, timepasses[].price & discounts[].price to plans

2015-05-07

Added accounting_code to invoice items.

2015-05-04

Added webhook for when time passes are removed from a membership. Added total_price_per_cycle to membership plans.

2015-04-21

Added notes field to invoices (admins only).

2015-04-17

Added webhook for when time passes are added to a membership.

2015-04-15

Added webhook for check-ins. Added endpoint /check_ins/:id

2015-03-27

Added comments field to bookings.

2015-02-12

Added accounting_code field to charges.

2015-01-20

Added min_booking_duration and max_booking_duration to resources.

2015-01-15

Added returning JSON when creating time passes.

2015-01-09

Added passing password when creating user.

2015-01-08

Added /charges endpoint.

2015-01-05

Added ignoring case of mac addresses used as check-in tokens.

2014-11-10

Added downloading invoice PDFs via API. Added changed_membership_plan webhook.

2014-11-05

Changed invoice items to return invoice's tax rate if their own is null.

2014-11-04

Added filtering booking subscriptions by resource id.

2014-10-24

Added paid_status to invoices.

2014-10-23

Added address to spaces.

2014-10-17

Added phone to memberships.

2014-10-14

Added hour_format to spaces (whether a country uses a 12h or 24h system).

2014-10-06

Added updated_payment_method webhook. Added automated attribute to membership payment method.

2014-10-02

Added /invoices/:invoice_number/charges endpoint.

2014-09-24

Added /teams endpoint for admins.

2014-09-08

Added ?all=true to /memberships endpoint.

2014-08-29

Added welcome_message to plans.

2014-08-01

Added endpoint for creating charges based invoices.

2014-07-31

Added id to charges. Added deleting charges.

2014-07-25

Added charged_at and quantity to charges.

2014-07-15

Added custom_domain attribute to spaces.

2014-07-08

Added billing_emails to memberships. Added GET memberships/:id/custom_fields endpoint.

2014-07-04

Added listing payment records by providing invoice_ids. Added from/to parameters to listing invoices for a membership.

2014-07-01

Removed day pass attributes from plans.

2014-06-28

Added expires_at to time passes.

2014-06-19

Added GET /check_in endpoint for retrieving a member's current check-in.

2014-06-06

Added webhooks for bookings.

2014-06-05

Added cancellation_period to resources, can_change to bookings.

2014-06-04

Added formatted_invoice_number to invoices.

2014-06-03

The iframe_url of a navigation link must now use https as browser will block http within https.

2014-05-27

Added invoice items endpoints.

2014-05-04

Added sent attribute to invoices.

2014-04-45

Added /invoices/:invoice_number/notifications endpoint for sending invoice emails.

2014-04-25

Added POST /memberships/:membership_id/invoices endpoint for creating invoices.

2014-04-15

Added /custom_fields endpoint.

2014-04-04

Added /admins endpoint. Added /activities endpoint.

2014-03-18

Added full_address to membership addresses. address, city, state and post_code should not be used anymore and will be removed in the future.

2014-03-07

Changed response code from 200 to 204 when returning an empty response (deleting bookings, deleting bookings).

2014-03-05

Removed mac_addresses and crypted_password from users.

2014-01-22

Added /memberships/:id/picture endpoint.

2014-01-21

Added /membership/bookings/upcoming enpoint.

2013-12-10

Added creating memberships with users and custom plans.

2013-10-20

Added /invoices/open endpoint.

2013-10-17

Added id to user memberships.

2013-10-09

Creating a membership no more sets up a payment method.

2013-10-06

Adds /team endpoint. Adds listing check-ins for team members.

2013-09-12

Adds attributes attributes to GET /memberships endpoint.

2013-09-11

Adds id/membership_id to check-in JSON.

2013-09-09

Adds DELETE '/memberships/:id/check_ins/current' for checking out. Adds POST check_in_tokens for adding tokens.

2013-09-06

The check_ins endpoint no more returns 409 when using a token that is already registered.

2013-08-29

Added as_of parameter, removed canceled_after for /memberships endpoint. Made /invoices endpoint accessible for members.

2013-07-06

Added /time_passes/unused endpoint to get unused time passes for all members as once. Added url and used_at to time passes.

2013-06-18

Made /work_sessions endpoint available for members as well.

2013-06-17

Added created_at to space endpoints.

2013-06-14

Removed authentication from list/show plans endpoints. Added canceled_after to memberships endpoint.

2013-05-21

Changed the quantity of invoice items from integer to decimal returned as string. What was {"quantity": 1} is now {"quantity": "1.0"}.

2013-04-25

Added canceled_membership event to webhooks API.

2013-04-24

Added /answers endpoint.

2013-04-11

Added /booking_credits enpoints.

2013-04-05

Added user ids to memberships.

2013-04-04

Added email to spaces. At the moment this uses the email of the user who created the space.

2013-03-19

Added picture to memberships. Removed it from users embedded in memberships.

2013-03-08

Added /memberships/cancellations endpoint. Added /activities endpoint.

2013-02-23

Removed plan terms, payment method instructions and internal memo from /memberships endpoint.

2013-02-22

Added CORS headers to all API calls so it can be used directly from browsers.

2013-02-21

Added valid_from/valid_until to /work_sessions endpoint.

2013-02-19

Added from/to parameters to /invoices endpoint.

2013-02-18

Added space name to /user endpoint. Added read_user scope for getting the current user's details.

2013-02-13

Added /api/check_in_tokens endpoints. Added the ability for members to use the /api/check_ins endpoint.

2013-02-07

Removed /api/spaces endpoint.

2013-01-09

Added /api/membership/bookings/recent endpoint.

2012-12-04

/api/memberships does not return canceled memberships anymore.

2012-11-27

Added capacity to resources.

2012-11-19

Replaced {"membership_id": "<id>"} in bookings with {"membership": {"id": "<id>", "name": "<name>"}}. membership_id is still there but removed from the documentation and will be removed from the API on or after 2013-01-01.

Replaced {"resource_name": "<name>"} in bookings with {"resource": {"id": "<id>", "name": "<name>"}}. resource_name is still there but removed from the documentation and will be removed from the API on or after 2013-01-01.

Added id to bookings and resources.

2012-11-13

Memberships now have next_invoice_at and upcoming_plan.

2012-08-08

Bookings now have a tax_rate field. The tax rate is returned as a String, e.g. 19.5.

2012-08-07

Invoices now have a tax_amounts hash instead of just one tax_amount. The new hash looks like {<tax_rate>: <amount>}, e.g. {"19.0": "200.0"}.

Invoice items now have a tax rate. If the tax rate is not set in the item the invoice\'s tax rate applies.

This is to support countries that have multiple VAT rates.

The old tax_amount attribute will be removed on or after 2012-10-01.