goteamup_get_authenticated_application
Get the authenticated application
Show the API application this token belongs to and the businesses (providers) it can reach, with their numeric ids — a cheap way to confirm the token works and to find the value for GOTEAMUP_PROVIDER_ID. TeamUp: GET /auth/application.
無需輸入參數。
goteamup_list_customers
List customers
Search and list the business's customers (members and leads). Filter by free text (email and name), CRM status, active memberships, age or family. Deferred fields such as field_values, credit_balance or sms_account can be added with expand. TeamUp: GET /customers.
輸入參數idspagequeryexpandfamilyfieldsstatusage_gteage_ltedeletedpage_sizeautocomplete另有 1 個
goteamup_get_customer
Get one customer
Fetch one customer by id: name, email, family role, lead flag, CRM status, created date. Use expand for deferred fields, e.g. field_values,credit_balance,staff_assignments. TeamUp: GET /customers/{id}.
輸入參數expandfieldscustomer_id必填
goteamup_list_events
List events (classes and appointments)
List scheduled sessions — classes and appointments — with start/end time, status, capacity, attending and waitlist counts, instructors, venue and offering type. Filter by time window, instructor, venue, offering type, status or occupancy. TeamUp: GET /events.
輸入參數idspagesortexpandfieldsstatusvenuespage_sizeends_at_gteends_at_lteinstructorsstarts_at_gte另有 3 個
goteamup_get_event
Get one event
Fetch one class or appointment by id, including capacity, attending/waiting counts, registration open/close and late-cancel deadlines. TeamUp: GET /events/{id}.
輸入參數expandfieldsevent_id必填
goteamup_list_attendances
List attendances (bookings)
List bookings: who is registered for, attended, no-showed or late-cancelled which event, and with which customer membership. Filter by customer, event, venue, offering type, status or event start window. Use expand=customer,event for names. TeamUp: GET /attendances.
輸入參數pagesorteventvenueexpandfieldsstatuscustomerpage_sizeoffering_typesevent_starts_at_gteevent_starts_at_lte
goteamup_list_customer_memberships
List customer memberships
List memberships held by customers — status (active, hold, complete, cancelled), start/expiration/renewal dates, billed price, active hold. Filter by customer, membership plan, type, status, dates or holds. TeamUp: GET /customer_memberships.
輸入參數idspagesortexpandfieldsstatuscustomerpage_sizemembershipstart_date_gtestart_date_ltehas_active_hold另有 3 個
goteamup_get_customer_membership
Get one customer membership
Fetch one customer membership by id. Use expand=usage_summary,next_billing_date,shared_with for usage, next bill and sharing. TeamUp: GET /customer_memberships/{id}.
輸入參數expandfieldscustomer_membership_id必填
goteamup_list_memberships
List memberships (plans)
List the membership products the business sells — packs, recurring and prepaid plans — with price, duration, allotment, active member count and visibility. TeamUp: GET /memberships.
輸入參數pageexpandfieldsfor_saleis_dropinpage_sizename_containsvisible_to_customerspermits_registration_for_event
goteamup_list_offering_types
List offering types (class types)
List offering types — the kinds of classes, appointments and courses the business runs — with schedule type, drop-in price, age limits, visibility and status. TeamUp: GET /offering_types.
輸入參數pagesortexpandfieldsstatuspage_sizename_containshas_active_sessions
goteamup_list_instructors
List instructors
List the business's instructors (coaches, trainers) with name, bio and linked staff id. TeamUp: GET /instructors.
輸入參數pagequeryexpandfieldspage_size
goteamup_list_venues
List venues
List the business's venues (physical locations and online venues) with address, timezone and rooms. TeamUp: GET /venues.
輸入參數pageexpandfieldsstatuspage_sizehas_active_sessions
goteamup_list_invoices
List invoices
List invoices with status (open, paid, failed, voided, upcoming, …), due date, amount due, payer and receipt URL. Filter by status or a customer membership. TeamUp: GET /invoices.
輸入參數pagesortexpandfieldsstatuspage_sizecustomer_membership
goteamup_get_invoice
Get one invoice
Fetch one invoice by id. Use expand=line_items,charges,discounts,taxes,applied_credits for the breakdown. TeamUp: GET /invoices/{id}.
輸入參數expandfieldsinvoice_id必填
goteamup_list_crm_interactions
List CRM interactions
List logged CRM interactions (calls, emails, meetings, contacted) with notes and who logged them, optionally for one customer. Requires a super_admin-level token. TeamUp: GET /crm/interactions.
輸入參數pageexpandfieldscustomerpage_size
goteamup_create_customer
Create (invite) a customer
Add a new customer to the business as staff. By default TeamUp emails them an invitation to claim the profile; set send_invitation_email=false to add them silently. TeamUp: POST /customers.
輸入參數emaillast_name必填first_name必填invitation_notesend_invitation_email
goteamup_register_customer_for_event
Book a customer into an event
Register a customer for a class or appointment, optionally using a specific customer membership, or comped (free). Returns the attendance id. Undo with goteamup_unregister_customer_from_event. TeamUp: POST /events/{id}/register.
輸入參數compedcustomer必填event_id必填customer_membership
goteamup_unregister_customer_from_event
Remove a customer from an event
Cancel a customer's booking for a class or appointment. is_late_cancel=true records it as a LATE cancel, which can trigger the business's penalty rules — leave it unset unless asked. The response says whether it counted as late. TeamUp: POST /events/{id}/unregister.
輸入參數customer必填event_id必填is_late_cancel
goteamup_confirm_attendance
Check a customer in
Confirm that a customer attended an event (check them in). Returns the updated attendance. TeamUp: POST /events/{id}/confirm_attendance.
輸入參數customer必填event_id必填
goteamup_log_crm_interaction
Log a CRM interaction
Record a call, email, meeting or contact with a customer or lead, with an optional note and call outcome. Requires a super_admin-level token. TeamUp: POST /crm/interactions.
輸入參數notecustomer必填call_outcomeinteraction_type必填