The Member object

Attributes

• member_id string required

  Unique identifier for the member.

• facility_id string either/orProvide the facility identifier type configured for your integration: use facility_id for direct-link integrations, or linking_identifier for linking-identifier integrations. Do not send both; the API uses the identifier type configured for your partner account and ignores the other one. Learn more

  Unique identifier of the facility from Performance Hub.

• linking_identifier string either/orProvide the facility identifier type configured for your integration: use facility_id for direct-link integrations, or linking_identifier for linking-identifier integrations. Do not send both; the API uses the identifier type configured for your partner account and ignores the other one. Learn more

  Unique identifier value for each location that the partner uses (e.g., "Branch ID", "Location Code", "Store Number"). Learn more

• first_name string required

  Member's first name.

• last_name string required

  Member's last name.

• email string optional

  Email address.

• mobile_phone string optional

  Mobile phone number in E.123 format (e.g., "+1 415 555 2671").

• address object optional

  Physical address object with the following properties:

  • address_line_1 (string) - Primary street address
  • address_line_2 (string, optional) - Secondary address line
  • city (string) - City name
  • state (string) - State/province code
  • postal_code (string) - Postal/ZIP code
  • country (string) - ISO 3166-1 alpha-2 country code (e.g., "AU", "US")
  • country_name (string, optional) - Full country name

• date_of_birth string optional

  Birth date in YYYY-MM-DD format.

• gender string optional

  One of male, female, non_binary, prefer_not_to_say, or unknown.

• type string optional

  Member type (e.g. staff, member, prospect).

• tags array optional

  Quick helper strings or texts to categorise and identify specific members (e.g. ["vip", "personal-training", "student"]).

• membership_status string optional

  Current membership status (e.g., active, expired, on_hold).

• membership_plans array optional

  Array of membership plans associated with the member.

• profile_picture string optional

  Base64-encoded profile picture (optional).

• created string optional

  ISO 8601 timestamp when the member was created.

• updated string optional

  ISO 8601 timestamp when the member was last updated.

• access_time_windows array optional

  Complete source-owned snapshot of absolute and/or recurring weekly Access Time Windows. Omit the field to leave the snapshot unchanged; send an empty array with a newer revision to revoke it. See Access Time Windows for the shapes, validation, scope mapping, and replacement semantics.

• access_time_windows_revision integer required with access_time_windows

  Monotonically increasing, non-negative JSON-safe integer for this member/source stream. Required whenever access_time_windows is present.

The Member object

{
  "member_id": "member_11111",
  "facility_id": "550e8400-e29b-41d4-a716-446655440000",
  // "linking_identifier": "branch_downtown",  // If using linking identifier
  "first_name": "John",
  "last_name": "Smith",
  "email": "john.smith@example.com",
  "mobile_phone": "+61 412 345 678",
  "date_of_birth": "1985-06-15",
  "gender": "male",
  "type": "member",
  "tags": ["vip", "personal-training"],
  "profile_picture": "/9j/4AAQSkZJRgABAQAAAQ...",
  "membership_status": "current",
  "created": "2024-01-15T10:30:00Z",
  "updated": "2024-01-20T14:45:00Z",
  "access_time_windows_revision": 1842,
  "access_time_windows": [
    {
      "external_id": "access-4b1782",
      "kind": "absolute",
      "from": 1792053000,
      "to": 1792058400,
      "timezone": "Australia/Perth",
      "scope_key": "after_hours_entry",
      "label": "Temporary site access"
    }
  ],
  "address": {
    "address_line_1": "456 Bourke Street",
    "address_line_2": "Apt 12",
    "city": "Melbourne",
    "state": "VIC",
    "postal_code": "3000",
    "country": "AU",
    "country_name": "Australia"
  },
  "membership_plans": [
    {
      "membership_plan_id": "plan_99999",
      "name": "Unlimited Monthly",
      "start_date": "2024-01-01T00:00:00Z",
      "status": "current",
      "is_current": true,
      "end_date": null
    }
  ]
}