Skip to content

Lead Capture and Sale Flow

This guide provides a comprehensive, step-by-step overview for onboarding members using the Glofox API.

GET: Register a Member

To register a member with a specific location, utilize the endpoints detailed in the Users section of the API reference.

Register UI screen

To create a new member within a particular studio, submit a request to the following endpoint:

  • Endpoint: /2.0/register
  • Method: GET
  • Content-Type: application/json

Required Headers

{
  "x-glofox-branch-id": "{branch_id}",
  "x-api-key": "{api_key}",
  "x-glofox-api-token": "{api_token}"
}

Request Body

{
  "first_name": "aliquip nostrud",
  "last_name": "consequat quis ut",
  "email": "john@test.com",
  "type": "MEMBER",
  "password": "password_$",
  "lead_status": "LEAD",
  "phone": "dolore adipisicing",
  "emergency_contact": "aliquip deserunt",
  "access_barcode": "Duis sed consectetur anim",
  "birth": "occaecat aute",
  "consent": {
    "email": { "active": true },
    "sms": { "active": false }
  }
}

GET: Waiver template

![Waiver UI screen]{.mobile-screenshots}

To present the waiver agreement to a member, retrieve the template using the member-authenticated trigger.

  • Endpoint: /2.3/branches/{branchId}/agreements/template/trigger/{trigger}
  • Method: GET
  • Content-Type: application/json

Memberships

In this section you will know how to do the onboarding flow with API calls and one sequencing constraint.

GET: Memberships

To browse and purchase memberships, use the memberships listing endpoint.

  • Endpoint: /2.0/memberships
  • Method: GET
  • Content-Type: application/json

Memberships Purchase Screen

Documentation

For more information, access the Electronic Agreements section on the API reference.

GET: Membership Terms & Conditions

Membership Terms Screen

The membership terms and conditions can be obtained from the same electronic agreements endpoint used for waivers.

  • Endpoint: /2.3/branches/{branchId}/agreements/template/trigger/{trigger}
  • Method: GET
  • Content-Type: application/json

Electronic Signature

If you wish to enable electronic signature during onboarding, the membership purchase must be completed before collecting the signature. Typically, the signature prompt appears on the subsequent screen. For implementation guidance on this flow, please contact the support team.