TeamUp

App · 25 actions

Connect TeamUp to manage your account records and automate everyday work.

Actions

ActionWhat it does
Confirm attendanceConfirm Attendance.
Create customerCreate.
Create eventCreate.
Create venueCreate.
Get connected applicationAuthenticated Application.
Get customerRetrieve.
Get customer account statusAccount Status.
Get customer missing formsList Missing Requisites.
Get eventRetrieve.
Get membershipRetrieve.
Get membership allotmentGet Allotment.
Get venueRetrieve.
Join waitlistJoin Waitlist.
Leave waitlistLeave Waitlist.
List customersList.
List eventsList.
List membershipsList.
List staffList.
List venuesList.
Mark no showMark No-show.
Register for eventRegister.
Unregister from eventUnregister.
Update customerPartially Update.
Update eventPartially Update.
Update venuePartially Update.

Confirm attendance

Confirm Attendance.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
IdidnumberRequired
A unique integer value identifying this event.
CustomercustomernumberRequired
The unique numeric identifier of the customer whose attendance to confirm.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "booking_source": {
      "id": 1,
      "name": "example"
    },
    "customer": {},
    "customer_membership": {},
    "event": {},
    "gympass_booking": {
      "access_validation_attempted_at": "2026-10-01T12:00:00Z",
      "access_validation_error": "example",
      "booking_number": "example",
      "checked_in_at": "2026-10-01T12:00:00Z",
      "id": 1,
      "is_access_validated": false,
      "object": "gympass_booking"
    },
    "id": 1,
    "object": "attendance",
    "status": "not_registered",
    "waitlist_spot": {
      "added_at": "2026-10-01T12:00:00Z",
      "id": 1,
      "object": "waitlist_spot",
      "position": 1,
      "reserved_spot_expires_at": "2026-10-01T12:00:00Z",
      "spot_reserved_at": "2026-10-01T12:00:00Z",
      "status": "on_waitlist"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Create customer

Create.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
First namefirst_nametextRequired
First name for this request.
Last namelast_nametextRequired
Last name for this request.
Emailemailtext
Email for this request.
Invitation noteinvitation_notetext
Invitation note for this request.
Field valuesfield_valueslist
Field values for this request.
Send invitation emailsend_invitation_emailtrue/false
Send invitation email for this request.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "created_at": "2026-10-01T12:00:00Z",
    "credit_balance": {
      "currency_symbol": "\u00a3",
      "currency_symbol_position": "before",
      "decimal": 1,
      "iso_currency_code": "gbp",
      "string": "\u00a345"
    },
    "customer_venue": {
      "address": "example",
      "archived": false,
      "description": "example",
      "id": 1,
      "is_online": false,
      "lat": 1,
      "lng": 1,
      "name": "example",
      "object": "venue",
      "physical_address": {
        "city": "example",
        "country": "example",
        "lat": 1,
        "lng": 1,
        "postal_code": "example",
        "region": "example",
        "street": "example",
        "street_secondary": "example"
      },
      "timezone": "example",
      "venue_rooms": {},
      "venue_type": "physical",
      "video_url": "example",
      "video_url_type": "static",
      "zoom_user": 1
    },
    "email": "example",
    "family": 1,
    "family_role": "manager",
    "field_values": [],
    "first_name": "example",
    "id": 1,
    "image": {
      "id": 13314,
      "original_height": 64,
      "original_width": 64,
      "url": "example"
    },
    "invitation_url": "example",
    "is_lead": false,
    "is_opted_into_broadcast_messages": false,
    "is_opted_into_sms_marketing": false,
    "is_status_locked": false,
    "last_name": "example",
    "lead_source": {},
    "object": "customer",
    "participating": false,
    "provider": {},
    "referral_code": {
      "code": "example",
      "share_url": "example"
    },
    "sms_account": {
      "country": "example",
      "enabled": false,
      "full_number": "example",
      "phone_number": "example",
      "verified": false
    },
    "staff_assignments": [],
    "status": "example",
    "visibility": "visible"
  },
  "has_more": false,
  "next_cursor": null
}

Create event

Create.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
Valuesvaluesobject
Values to send, using the fields documented by the app.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "active_registration_status": {
      "cancellation_closes_at": "2026-10-01T12:00:00Z",
      "current_status": "spot_reserved",
      "late_cancels_after": "2026-10-01T12:00:00Z",
      "registrations_close_at": "2026-10-01T12:00:00Z",
      "registrations_open_at": "2026-10-01T12:00:00Z",
      "restriction_codes": [],
      "suggested_action": "register"
    },
    "attending_count": 1,
    "category": {
      "id": 1,
      "image": {
        "id": 13314,
        "original_height": 64,
        "original_width": 64,
        "url": "example"
      },
      "name": "example",
      "object": "offering_type_category"
    },
    "customer_url": "example",
    "description": "example",
    "ends_at": "2026-10-01T12:00:00Z",
    "id": 1,
    "instructors": {},
    "is_appointment": "example",
    "is_full": false,
    "late_cancel_deadline": "2026-10-01T12:00:00Z",
    "max_occupancy": 1,
    "name": "example",
    "object": "event",
    "offering_type": {},
    "overriden_registration_timelines": [],
    "provider_url": "example",
    "registrations_close_at": "2026-10-01T12:00:00Z",
    "registrations_open_at": "2026-10-01T12:00:00Z",
    "schedule_type": "example",
    "small_session_attendances": {},
    "starts_at": "2026-10-01T12:00:00Z",
    "status": "active",
    "venue": {},
    "venue_room": {},
    "waiting_count": 1,
    "waitlist_max_override": 1
  },
  "has_more": false,
  "next_cursor": null
}

Create venue

Create.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
NamenametextRequired
Name for this request.
Venue typevenue_typetextRequired
Venue type for this request.One of: physical, online.
Descriptiondescriptiontext
Description for this request.
Physical addressphysical_addressobject
Physical address for this request.
TimezonetimezonetextRequired
Timezone for this request.
Video urlvideo_urltext
Video url for this request.
Video url typevideo_url_typetext
Video url type for this request.One of: static, zoom.
Zoom userzoom_usernumber
Zoom user for this request.
Archivedarchivedtrue/false
Archived for this request.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "address": "example",
    "archived": false,
    "description": "example",
    "id": 1,
    "is_online": false,
    "lat": 1,
    "lng": 1,
    "name": "example",
    "object": "venue",
    "physical_address": {
      "city": "example",
      "country": "example",
      "lat": 1,
      "lng": 1,
      "postal_code": "example",
      "region": "example",
      "street": "example",
      "street_secondary": "example"
    },
    "timezone": "example",
    "venue_rooms": {},
    "venue_type": "physical",
    "video_url": "example",
    "video_url_type": "static",
    "zoom_user": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get connected application

Authenticated Application.

Inputs

None.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "id": 1,
    "name": "example",
    "object": "authenticated_application",
    "scoped_providers": []
  },
  "has_more": false,
  "next_cursor": null
}

Get customer

Retrieve.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
IdidnumberRequired
A unique integer value identifying this provider customer profile.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "created_at": "2026-10-01T12:00:00Z",
    "credit_balance": {
      "currency_symbol": "\u00a3",
      "currency_symbol_position": "before",
      "decimal": 1,
      "iso_currency_code": "gbp",
      "string": "\u00a345"
    },
    "customer_venue": {
      "address": "example",
      "archived": false,
      "description": "example",
      "id": 1,
      "is_online": false,
      "lat": 1,
      "lng": 1,
      "name": "example",
      "object": "venue",
      "physical_address": {
        "city": "example",
        "country": "example",
        "lat": 1,
        "lng": 1,
        "postal_code": "example",
        "region": "example",
        "street": "example",
        "street_secondary": "example"
      },
      "timezone": "example",
      "venue_rooms": {},
      "venue_type": "physical",
      "video_url": "example",
      "video_url_type": "static",
      "zoom_user": 1
    },
    "email": "example",
    "family": 1,
    "family_role": "manager",
    "field_values": [],
    "first_name": "example",
    "id": 1,
    "image": {
      "id": 13314,
      "original_height": 64,
      "original_width": 64,
      "url": "example"
    },
    "invitation_url": "example",
    "is_lead": false,
    "is_opted_into_broadcast_messages": false,
    "is_opted_into_sms_marketing": false,
    "is_status_locked": false,
    "last_name": "example",
    "lead_source": {},
    "object": "customer",
    "participating": false,
    "provider": {},
    "referral_code": {
      "code": "example",
      "share_url": "example"
    },
    "sms_account": {
      "country": "example",
      "enabled": false,
      "full_number": "example",
      "phone_number": "example",
      "verified": false
    },
    "staff_assignments": [],
    "status": "example",
    "visibility": "visible"
  },
  "has_more": false,
  "next_cursor": null
}

Get customer account status

Account Status.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
IdidnumberRequired
A unique integer value identifying this provider customer profile.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "created_at": "2026-10-01T12:00:00Z",
    "credit_balance": {
      "currency_symbol": "\u00a3",
      "currency_symbol_position": "before",
      "decimal": 1,
      "iso_currency_code": "gbp",
      "string": "\u00a345"
    },
    "customer_venue": {
      "address": "example",
      "archived": false,
      "description": "example",
      "id": 1,
      "is_online": false,
      "lat": 1,
      "lng": 1,
      "name": "example",
      "object": "venue",
      "physical_address": {
        "city": "example",
        "country": "example",
        "lat": 1,
        "lng": 1,
        "postal_code": "example",
        "region": "example",
        "street": "example",
        "street_secondary": "example"
      },
      "timezone": "example",
      "venue_rooms": {},
      "venue_type": "physical",
      "video_url": "example",
      "video_url_type": "static",
      "zoom_user": 1
    },
    "email": "example",
    "family": 1,
    "family_role": "manager",
    "field_values": [],
    "first_name": "example",
    "id": 1,
    "image": {
      "id": 13314,
      "original_height": 64,
      "original_width": 64,
      "url": "example"
    },
    "invitation_url": "example",
    "is_lead": false,
    "is_opted_into_broadcast_messages": false,
    "is_opted_into_sms_marketing": false,
    "is_status_locked": false,
    "last_name": "example",
    "lead_source": {},
    "object": "customer",
    "participating": false,
    "provider": {},
    "referral_code": {
      "code": "example",
      "share_url": "example"
    },
    "sms_account": {
      "country": "example",
      "enabled": false,
      "full_number": "example",
      "phone_number": "example",
      "verified": false
    },
    "staff_assignments": [],
    "status": "example",
    "visibility": "visible"
  },
  "has_more": false,
  "next_cursor": null
}

Get customer missing forms

List Missing Requisites.

Inputs

Hypothetical membershiphypothetical_membershiptext
Membership id(s) to include as a hypothetical purchase. Comma-separated.
Hypothetical offering typehypothetical_offering_typetext
Offering type id(s) to include as a hypothetical registration. Comma-separated.
IdidnumberRequired
A unique integer value identifying this provider customer profile.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "missing_forms": "example",
    "missing_requisites_workflow_url": "example",
    "missing_waivers": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get event

Retrieve.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
IdidnumberRequired
A unique integer value identifying this event.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "active_registration_status": {
      "cancellation_closes_at": "2026-10-01T12:00:00Z",
      "current_status": "spot_reserved",
      "late_cancels_after": "2026-10-01T12:00:00Z",
      "registrations_close_at": "2026-10-01T12:00:00Z",
      "registrations_open_at": "2026-10-01T12:00:00Z",
      "restriction_codes": [],
      "suggested_action": "register"
    },
    "attending_count": 1,
    "category": {
      "id": 1,
      "image": {
        "id": 13314,
        "original_height": 64,
        "original_width": 64,
        "url": "example"
      },
      "name": "example",
      "object": "offering_type_category"
    },
    "customer_url": "example",
    "description": "example",
    "ends_at": "2026-10-01T12:00:00Z",
    "id": 1,
    "instructors": {},
    "is_appointment": "example",
    "is_full": false,
    "late_cancel_deadline": "2026-10-01T12:00:00Z",
    "max_occupancy": 1,
    "name": "example",
    "object": "event",
    "offering_type": {},
    "overriden_registration_timelines": [],
    "provider_url": "example",
    "registrations_close_at": "2026-10-01T12:00:00Z",
    "registrations_open_at": "2026-10-01T12:00:00Z",
    "schedule_type": "example",
    "small_session_attendances": {},
    "starts_at": "2026-10-01T12:00:00Z",
    "status": "active",
    "venue": {},
    "venue_room": {},
    "waiting_count": 1,
    "waitlist_max_override": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get membership

Retrieve.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
IdidnumberRequired
A unique integer value identifying this membership.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "active_member_count": 1,
    "allotment": "example",
    "allow_repeat_purchases": false,
    "begin_on_first_registration": false,
    "category": {},
    "description": "example",
    "display_price": {
      "currency_symbol": "\u00a3",
      "currency_symbol_position": "before",
      "decimal": 1,
      "iso_currency_code": "gbp",
      "string": "\u00a345"
    },
    "duration": 1,
    "duration_unit": "days",
    "expiration_date": "2026-10-01",
    "for_sale": false,
    "has_active_members": false,
    "id": 1,
    "incomplete_reasons": [],
    "is_draft": false,
    "is_dropin": false,
    "name": "example",
    "new_customers_only": false,
    "object": "membership",
    "one_time_fee": {
      "currency_symbol": "\u00a3",
      "currency_symbol_position": "before",
      "decimal": 1,
      "iso_currency_code": "gbp",
      "string": "\u00a345"
    },
    "penalty_system": {},
    "plans": {},
    "price": {
      "currency_symbol": "\u00a3",
      "currency_symbol_position": "before",
      "decimal": 1,
      "iso_currency_code": "gbp",
      "string": "\u00a345"
    },
    "purchasable_only_by_provider": false,
    "shareable": false,
    "start_date": "2026-10-01",
    "terms": {},
    "type": "pack",
    "use_prorate": false,
    "visible_to_customers": false
  },
  "has_more": false,
  "next_cursor": null
}

Get membership allotment

Get Allotment.

Inputs

IdidnumberRequired
A unique integer value identifying this membership.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "ignore_no_shows": false,
    "period_limits": [],
    "types": []
  },
  "has_more": false,
  "next_cursor": null
}

Get venue

Retrieve.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
IdidnumberRequired
A unique integer value identifying this venue.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "address": "example",
    "archived": false,
    "description": "example",
    "id": 1,
    "is_online": false,
    "lat": 1,
    "lng": 1,
    "name": "example",
    "object": "venue",
    "physical_address": {
      "city": "example",
      "country": "example",
      "lat": 1,
      "lng": 1,
      "postal_code": "example",
      "region": "example",
      "street": "example",
      "street_secondary": "example"
    },
    "timezone": "example",
    "venue_rooms": {},
    "venue_type": "physical",
    "video_url": "example",
    "video_url_type": "static",
    "zoom_user": 1
  },
  "has_more": false,
  "next_cursor": null
}

Join waitlist

Join Waitlist.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
IdidnumberRequired
A unique integer value identifying this event.
CustomercustomernumberRequired
Customer for this request.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "added_at": "2026-10-01T12:00:00Z",
    "id": 1,
    "object": "waitlist_spot",
    "position": 1,
    "reserved_spot_expires_at": "2026-10-01T12:00:00Z",
    "spot_reserved_at": "2026-10-01T12:00:00Z",
    "status": "on_waitlist"
  },
  "has_more": false,
  "next_cursor": null
}

Leave waitlist

Leave Waitlist.

Inputs

IdidnumberRequired
A unique integer value identifying this event.
CustomercustomernumberRequired
Customer for this request.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "customer": 1
  },
  "has_more": false,
  "next_cursor": null
}

List customers

List.

Inputs

Active membershipsactive_membershipslist
Filter customers by active memberships. Format as comma-separated id values.
Age gteage_gtenumber
Filter customers by age greater than or equal to a given value.
Age lteage_ltenumber
Filter customers by age less than or equal to a given value.
Autocompleteautocompletetext
Autocomplete filter by a free-text string. Matches from the start of the email and name fields.
Broadcast message non recipientsbroadcast_message_non_recipientsnumber
Given a BroadcastMessage ID, return the targeted customers who will not receive the message.
Broadcast message recipientsbroadcast_message_recipientsnumber
Given a BroadcastMessage ID, return the customers who will receive the message.
Can deletecan_deletetrue/false
Only include customers if they are deletable.
Deleteddeletedtrue/false
Filter customers by whether or not they are deleted.
Expandexpandlist
A comma-separated list of fields to expand.
Familyfamilynumber
Only include customers in a particular family. Format as numeric family id.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
Idsidslist
Only return particular customer. Format as comma-separated id values.
Pagepagenumber
A page number within the paginated result set.At least 1.
Page sizepage_sizenumber
Number of results to return per page.From 1 to 100.
Queryquerytext
Filter by a free-text string. Checks the email and name fields.
Statusstatuslist
Filter customers by status. Format as comma-separated status slugs. Pass null to filter for customers without a status.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "count": 123,
    "next": "http://api.example.org/accounts/?page=4",
    "page": 1,
    "page_size": 100,
    "previous": "http://api.example.org/accounts/?page=2",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List events

List.

Inputs

Active customeractive_customernumber
Set the customer who will parameterize any customer-specific fields in the response, such as active_registration_timeline
Applicable to recurring reservationapplicable_to_recurring_reservationnumber
Only include events that match a recurring reservation's criteria. Format a reservation's unique id.
Categorycategorylist
Only include events for particular categories. Format as comma-separate offering type category id values.
Ends at gteends_at_gtedate and time
Only include events that end on or after a given timestamp.
Ends at lteends_at_ltedate and time
Only include events that end on or before a given timestamp.
Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
Idsidslist
Only include particular events. Format as comma-separated event id values.
Instructorsinstructorsnumber
Only include events taught by particular instructors. Format as comma-separated instructor id values, or use me to indicate events taught by yourself.
Local starts at gtelocal_starts_at_gtedate and time
Only include events that start on or after a given timestamp in the venue's local timezone.
Local starts at ltelocal_starts_at_ltedate and time
Only include events that start on or before a given timestamp in the venue's local timezone..
Max allowed agemax_allowed_agenumber
Only include events with a maximum allowed age of a given values in years.
Min allowed agemin_allowed_agenumber
Only include events with a minimum allowed age of a given values in years.
Occupancy statusoccupancy_statuslist
Only include events with at least one of the following occupancy statuses.One or more of: full, has_registrations, has_waitlist, empty, not_full.
Offering typesoffering_typeslist
Only include events for particular offering types. Format as comma-separated offering type id values.
Pagepagenumber
A page number within the paginated result set.At least 1.
Page sizepage_sizenumber
Number of results to return per page.From 1 to 100.
Registration timelinesregistration_timelineslist
Only include events associated with particular registration timelines. Format as comma-separated timeline id values.
Sortsortlist
Ordering * start - Start * -start - Start (descending) * end - End * -end - End (descending)One or more of: -end, -start, end, start.
Start gtestart_gtedate and time
Deprecated. Use starts_at_gte.
Start ltestart_ltedate and time
Deprecated. Use starts_at_lte.
Starts at gtestarts_at_gtedate and time
Only include events that start on or after a given timestamp.
Starts at ltestarts_at_ltedate and time
Only include events that start on or before a given timestamp.
Statusstatuslist
Only include events with a particular status.One or more of: active, cancelled.
Venuesvenueslist
Only include events at particular venues. Format as comma-separated venue id values.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "count": 123,
    "next": "http://api.example.org/accounts/?page=4",
    "page": 1,
    "page_size": 100,
    "previous": "http://api.example.org/accounts/?page=2",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List memberships

List.

Inputs

Allow repeat purchasesallow_repeat_purchasestrue/false
Allow repeat purchases for this request.
Categoriescategorieslist
Only include memberships with particular categories. Format as category id values.
Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
For salefor_saletrue/false
For sale for this request.
Formsformslist
Only include memberships related to particular forms. Format as form id values.
Is dropinis_dropintrue/false
Is dropin for this request.
Name containsname_containstext
Only include memberships whose name contains the provided text.
Offering typeoffering_typetext
Offering type for this request.
Pagepagenumber
A page number within the paginated result set.At least 1.
Page sizepage_sizenumber
Number of results to return per page.From 1 to 100.
Permits registration for coursepermits_registration_for_coursenumber
Permits registration for course for this request.
Permits registration for eventpermits_registration_for_eventnumber
Permits registration for event for this request.
Visible to customersvisible_to_customerstrue/false
Visible to customers for this request.
Waiverswaiverslist
Only include memberships related to particular waivers. Format as waiver id values.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "count": 123,
    "next": "http://api.example.org/accounts/?page=4",
    "page": 1,
    "page_size": 100,
    "previous": "http://api.example.org/accounts/?page=2",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List staff

List.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
Has any permissionshas_any_permissionslist
Only include staff that have at least one of these permissions.One or more of: email_notifications, revenue, attendances, super_admin, customers, discount_codes, manage_events, store, developer, customer_payments, instructor_attendances, instructor_manage_events.
Pagepagenumber
A page number within the paginated result set.At least 1.
Page sizepage_sizenumber
Number of results to return per page.From 1 to 100.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "count": 123,
    "next": "http://api.example.org/accounts/?page=4",
    "page": 1,
    "page_size": 100,
    "previous": "http://api.example.org/accounts/?page=2",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List venues

List.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
Has active sessionshas_active_sessionstrue/false
Only include venues with non-cancelled events or course sessions.
Pagepagenumber
A page number within the paginated result set.At least 1.
Page sizepage_sizenumber
Number of results to return per page.From 1 to 100.
Statusstatustext
* active - active * archived - archivedOne of: active, archived.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "count": 123,
    "next": "http://api.example.org/accounts/?page=4",
    "page": 1,
    "page_size": 100,
    "previous": "http://api.example.org/accounts/?page=2",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Mark no show

Mark No-show.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
IdidnumberRequired
A unique integer value identifying this event.
CustomercustomernumberRequired
The unique numeric identifier of the customer whose attendance to mark as no-show.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "booking_source": {
      "id": 1,
      "name": "example"
    },
    "customer": {},
    "customer_membership": {},
    "event": {},
    "gympass_booking": {
      "access_validation_attempted_at": "2026-10-01T12:00:00Z",
      "access_validation_error": "example",
      "booking_number": "example",
      "checked_in_at": "2026-10-01T12:00:00Z",
      "id": 1,
      "is_access_validated": false,
      "object": "gympass_booking"
    },
    "id": 1,
    "object": "attendance",
    "status": "not_registered",
    "waitlist_spot": {
      "added_at": "2026-10-01T12:00:00Z",
      "id": 1,
      "object": "waitlist_spot",
      "position": 1,
      "reserved_spot_expires_at": "2026-10-01T12:00:00Z",
      "spot_reserved_at": "2026-10-01T12:00:00Z",
      "status": "on_waitlist"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Register for event

Register.

Inputs

IdidnumberRequired
A unique integer value identifying this event.
CustomercustomernumberRequired
Customer for this request.
Customer membershipcustomer_membershipnumber
Customer membership for this request.
Compedcompedtrue/false
Whether this registration is comped or not. Only available in provider mode.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "attendance": 1
  },
  "has_more": false,
  "next_cursor": null
}

Unregister from event

Unregister.

Inputs

IdidnumberRequired
A unique integer value identifying this event.
CustomercustomernumberRequired
The unique numeric identifier of the customer to unregister.
Is late cancelis_late_canceltrue/false
Can only be set in provider mode. If a customer makes the request, the late cancellation deadline will be used.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "attendance": 1,
    "late": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Update customer

Partially Update.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
IdidnumberRequired
A unique integer value identifying this provider customer profile.
First namefirst_nametext
First name for this request.
Last namelast_nametext
Last name for this request.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "created_at": "2026-10-01T12:00:00Z",
    "credit_balance": {
      "currency_symbol": "\u00a3",
      "currency_symbol_position": "before",
      "decimal": 1,
      "iso_currency_code": "gbp",
      "string": "\u00a345"
    },
    "customer_venue": {
      "address": "example",
      "archived": false,
      "description": "example",
      "id": 1,
      "is_online": false,
      "lat": 1,
      "lng": 1,
      "name": "example",
      "object": "venue",
      "physical_address": {
        "city": "example",
        "country": "example",
        "lat": 1,
        "lng": 1,
        "postal_code": "example",
        "region": "example",
        "street": "example",
        "street_secondary": "example"
      },
      "timezone": "example",
      "venue_rooms": {},
      "venue_type": "physical",
      "video_url": "example",
      "video_url_type": "static",
      "zoom_user": 1
    },
    "email": "example",
    "family": 1,
    "family_role": "manager",
    "field_values": [],
    "first_name": "example",
    "id": 1,
    "image": {
      "id": 13314,
      "original_height": 64,
      "original_width": 64,
      "url": "example"
    },
    "invitation_url": "example",
    "is_lead": false,
    "is_opted_into_broadcast_messages": false,
    "is_opted_into_sms_marketing": false,
    "is_status_locked": false,
    "last_name": "example",
    "lead_source": {},
    "object": "customer",
    "participating": false,
    "provider": {},
    "referral_code": {
      "code": "example",
      "share_url": "example"
    },
    "sms_account": {
      "country": "example",
      "enabled": false,
      "full_number": "example",
      "phone_number": "example",
      "verified": false
    },
    "staff_assignments": [],
    "status": "example",
    "visibility": "visible"
  },
  "has_more": false,
  "next_cursor": null
}

Update event

Partially Update.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
IdidnumberRequired
A unique integer value identifying this event.
Valuesvaluesobject
Values to send, using the fields documented by the app.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "active_registration_status": {
      "cancellation_closes_at": "2026-10-01T12:00:00Z",
      "current_status": "spot_reserved",
      "late_cancels_after": "2026-10-01T12:00:00Z",
      "registrations_close_at": "2026-10-01T12:00:00Z",
      "registrations_open_at": "2026-10-01T12:00:00Z",
      "restriction_codes": [],
      "suggested_action": "register"
    },
    "attending_count": 1,
    "category": {
      "id": 1,
      "image": {
        "id": 13314,
        "original_height": 64,
        "original_width": 64,
        "url": "example"
      },
      "name": "example",
      "object": "offering_type_category"
    },
    "customer_url": "example",
    "description": "example",
    "ends_at": "2026-10-01T12:00:00Z",
    "id": 1,
    "instructors": {},
    "is_appointment": "example",
    "is_full": false,
    "late_cancel_deadline": "2026-10-01T12:00:00Z",
    "max_occupancy": 1,
    "name": "example",
    "object": "event",
    "offering_type": {},
    "overriden_registration_timelines": [],
    "provider_url": "example",
    "registrations_close_at": "2026-10-01T12:00:00Z",
    "registrations_open_at": "2026-10-01T12:00:00Z",
    "schedule_type": "example",
    "small_session_attendances": {},
    "starts_at": "2026-10-01T12:00:00Z",
    "status": "active",
    "venue": {},
    "venue_room": {},
    "waiting_count": 1,
    "waitlist_max_override": 1
  },
  "has_more": false,
  "next_cursor": null
}

Update venue

Partially Update.

Inputs

Expandexpandlist
A comma-separated list of fields to expand.
Fieldsfieldslist
A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
IdidnumberRequired
A unique integer value identifying this venue.
Namenametext
Name for this request.
Venue typevenue_typetext
Venue type for this request.One of: physical, online.
Descriptiondescriptiontext
Description for this request.
Physical addressphysical_addressobject
Physical address for this request.
Timezonetimezonetext
Timezone for this request.
Video urlvideo_urltext
Video url for this request.
Video url typevideo_url_typetext
Video url type for this request.One of: static, zoom.
Zoom userzoom_usernumber
Zoom user for this request.
Archivedarchivedtrue/false
Archived for this request.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "address": "example",
    "archived": false,
    "description": "example",
    "id": 1,
    "is_online": false,
    "lat": 1,
    "lng": 1,
    "name": "example",
    "object": "venue",
    "physical_address": {
      "city": "example",
      "country": "example",
      "lat": 1,
      "lng": 1,
      "postal_code": "example",
      "region": "example",
      "street": "example",
      "street_secondary": "example"
    },
    "timezone": "example",
    "venue_rooms": {},
    "venue_type": "physical",
    "video_url": "example",
    "video_url_type": "static",
    "zoom_user": 1
  },
  "has_more": false,
  "next_cursor": null
}

On this page