# TeamUp

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

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/teamup

## Actions

### Confirm attendance

Confirm Attendance.

**Inputs**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Id (`id`, number, required): A unique integer value identifying this event.
- Customer (`customer`, number, required): The unique numeric identifier of the customer whose attendance to confirm.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- First name (`first_name`, text, required): First name for this request.
- Last name (`last_name`, text, required): Last name for this request.
- Email (`email`, text): Email for this request.
- Invitation note (`invitation_note`, text): Invitation note for this request.
- Field values (`field_values`, list): Field values for this request.
- Send invitation email (`send_invitation_email`, true/false): Send invitation email for this request.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Values (`values`, object): Values to send, using the fields documented by the app.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Name (`name`, text, required): Name for this request.
- Venue type (`venue_type`, text, required): Venue type for this request. One of: `physical`, `online`.
- Description (`description`, text): Description for this request.
- Physical address (`physical_address`, object): Physical address for this request.
- Timezone (`timezone`, text, required): Timezone for this request.
- Video url (`video_url`, text): Video url for this request.
- Video url type (`video_url_type`, text): Video url type for this request. One of: `static`, `zoom`.
- Zoom user (`zoom_user`, number): Zoom user for this request.
- Archived (`archived`, true/false): Archived for this request.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "id": 1,
    "name": "example",
    "object": "authenticated_application",
    "scoped_providers": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get customer

Retrieve.

**Inputs**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Id (`id`, number, required): A unique integer value identifying this provider customer profile.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Id (`id`, number, required): A unique integer value identifying this provider customer profile.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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 membership (`hypothetical_membership`, text): Membership id(s) to include as a hypothetical purchase. Comma-separated.
- Hypothetical offering type (`hypothetical_offering_type`, text): Offering type id(s) to include as a hypothetical registration. Comma-separated.
- Id (`id`, number, required): A unique integer value identifying this provider customer profile.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "missing_forms": "example",
    "missing_requisites_workflow_url": "example",
    "missing_waivers": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get event

Retrieve.

**Inputs**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Id (`id`, number, required): A unique integer value identifying this event.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Id (`id`, number, required): A unique integer value identifying this membership.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): A unique integer value identifying this membership.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "ignore_no_shows": false,
    "period_limits": [],
    "types": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get venue

Retrieve.

**Inputs**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Id (`id`, number, required): A unique integer value identifying this venue.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Id (`id`, number, required): A unique integer value identifying this event.
- Customer (`customer`, number, required): Customer for this request.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): A unique integer value identifying this event.
- Customer (`customer`, number, required): Customer for this request.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "customer": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### List customers

List.

**Inputs**

- Active memberships (`active_memberships`, list): Filter customers by active memberships. Format as comma-separated id values.
- Age gte (`age_gte`, number): Filter customers by age greater than or equal to a given value.
- Age lte (`age_lte`, number): Filter customers by age less than or equal to a given value.
- Autocomplete (`autocomplete`, text): Autocomplete filter by a free-text string. Matches from the start of the email and name fields.
- Broadcast message non recipients (`broadcast_message_non_recipients`, number): Given a BroadcastMessage ID, return the targeted customers who will not receive the message.
- Broadcast message recipients (`broadcast_message_recipients`, number): Given a BroadcastMessage ID, return the customers who will receive the message.
- Can delete (`can_delete`, true/false): Only include customers if they are deletable.
- Deleted (`deleted`, true/false): Filter customers by whether or not they are deleted.
- Expand (`expand`, list): A comma-separated list of fields to expand.
- Family (`family`, number): Only include customers in a particular family. Format as numeric family id.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Ids (`ids`, list): Only return particular customer. Format as comma-separated id values.
- Page (`page`, number): A page number within the paginated result set. At least 1.
- Page size (`page_size`, number): Number of results to return per page. From 1 to 100.
- Query (`query`, text): Filter by a free-text string. Checks the email and name fields.
- Status (`status`, list): Filter customers by status. Format as comma-separated status slugs. Pass null to filter for customers without a status.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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 customer (`active_customer`, number): Set the customer who will parameterize any customer-specific fields in the response, such as active_registration_timeline
- Applicable to recurring reservation (`applicable_to_recurring_reservation`, number): Only include events that match a recurring reservation's criteria. Format a reservation's unique id.
- Category (`category`, list): Only include events for particular categories. Format as comma-separate offering type category id values.
- Ends at gte (`ends_at_gte`, date and time): Only include events that end on or after a given timestamp.
- Ends at lte (`ends_at_lte`, date and time): Only include events that end on or before a given timestamp.
- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Ids (`ids`, list): Only include particular events. Format as comma-separated event id values.
- Instructors (`instructors`, number): 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 gte (`local_starts_at_gte`, date and time): Only include events that start on or after a given timestamp in the venue's local timezone.
- Local starts at lte (`local_starts_at_lte`, date and time): Only include events that start on or before a given timestamp in the venue's local timezone..
- Max allowed age (`max_allowed_age`, number): Only include events with a maximum allowed age of a given values in years.
- Min allowed age (`min_allowed_age`, number): Only include events with a minimum allowed age of a given values in years.
- Occupancy status (`occupancy_status`, list): 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 types (`offering_types`, list): Only include events for particular offering types. Format as comma-separated offering type id values.
- Page (`page`, number): A page number within the paginated result set. At least 1.
- Page size (`page_size`, number): Number of results to return per page. From 1 to 100.
- Registration timelines (`registration_timelines`, list): Only include events associated with particular registration timelines. Format as comma-separated timeline id values.
- Sort (`sort`, list): Ordering * start - Start * -start - Start (descending) * end - End * -end - End (descending). One or more of: `-end`, `-start`, `end`, `start`.
- Start gte (`start_gte`, date and time): Deprecated. Use starts_at_gte.
- Start lte (`start_lte`, date and time): Deprecated. Use starts_at_lte.
- Starts at gte (`starts_at_gte`, date and time): Only include events that start on or after a given timestamp.
- Starts at lte (`starts_at_lte`, date and time): Only include events that start on or before a given timestamp.
- Status (`status`, list): Only include events with a particular status. One or more of: `active`, `cancelled`.
- Venues (`venues`, list): Only include events at particular venues. Format as comma-separated venue id values.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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 purchases (`allow_repeat_purchases`, true/false): Allow repeat purchases for this request.
- Categories (`categories`, list): Only include memberships with particular categories. Format as category id values.
- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- For sale (`for_sale`, true/false): For sale for this request.
- Forms (`forms`, list): Only include memberships related to particular forms. Format as form id values.
- Is dropin (`is_dropin`, true/false): Is dropin for this request.
- Name contains (`name_contains`, text): Only include memberships whose name contains the provided text.
- Offering type (`offering_type`, text): Offering type for this request.
- Page (`page`, number): A page number within the paginated result set. At least 1.
- Page size (`page_size`, number): Number of results to return per page. From 1 to 100.
- Permits registration for course (`permits_registration_for_course`, number): Permits registration for course for this request.
- Permits registration for event (`permits_registration_for_event`, number): Permits registration for event for this request.
- Visible to customers (`visible_to_customers`, true/false): Visible to customers for this request.
- Waivers (`waivers`, list): Only include memberships related to particular waivers. Format as waiver id values.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Has any permissions (`has_any_permissions`, list): 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`.
- Page (`page`, number): A page number within the paginated result set. At least 1.
- Page size (`page_size`, number): Number of results to return per page. From 1 to 100.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Has active sessions (`has_active_sessions`, true/false): Only include venues with non-cancelled events or course sessions.
- Page (`page`, number): A page number within the paginated result set. At least 1.
- Page size (`page_size`, number): Number of results to return per page. From 1 to 100.
- Status (`status`, text): * active - active * archived - archived. One of: `active`, `archived`.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Id (`id`, number, required): A unique integer value identifying this event.
- Customer (`customer`, number, required): The unique numeric identifier of the customer whose attendance to mark as no-show.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Id (`id`, number, required): A unique integer value identifying this event.
- Customer (`customer`, number, required): Customer for this request.
- Customer membership (`customer_membership`, number): Customer membership for this request.
- Comped (`comped`, true/false): Whether this registration is comped or not. Only available in provider mode.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "attendance": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### Unregister from event

Unregister.

**Inputs**

- Id (`id`, number, required): A unique integer value identifying this event.
- Customer (`customer`, number, required): The unique numeric identifier of the customer to unregister.
- Is late cancel (`is_late_cancel`, true/false): Can only be set in provider mode. If a customer makes the request, the late cancellation deadline will be used.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "attendance": 1,
    "late": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Update customer

Partially Update.

**Inputs**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Id (`id`, number, required): A unique integer value identifying this provider customer profile.
- First name (`first_name`, text): First name for this request.
- Last name (`last_name`, text): Last name for this request.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Id (`id`, number, required): A unique integer value identifying this event.
- Values (`values`, object): Values to send, using the fields documented by the app.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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**

- Expand (`expand`, list): A comma-separated list of fields to expand.
- Fields (`fields`, list): A comma-separated list of fields to include. Dot-notation can be used to select nested fields.
- Id (`id`, number, required): A unique integer value identifying this venue.
- Name (`name`, text): Name for this request.
- Venue type (`venue_type`, text): Venue type for this request. One of: `physical`, `online`.
- Description (`description`, text): Description for this request.
- Physical address (`physical_address`, object): Physical address for this request.
- Timezone (`timezone`, text): Timezone for this request.
- Video url (`video_url`, text): Video url for this request.
- Video url type (`video_url_type`, text): Video url type for this request. One of: `static`, `zoom`.
- Zoom user (`zoom_user`, number): Zoom user for this request.
- Archived (`archived`, true/false): Archived for this request.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "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
}
```
