Skip to main content
GET
/
v1
/
members
/
{memberId}
/
health-team
List health team
curl --request GET \
  --url https://api.halth.com/v1/members/{memberId}/health-team
{
  "items": [
    {
      "id": "<string>",
      "organisation": {
        "id": "<string>",
        "slug": "<string>",
        "name": "<string>",
        "bookingsEnabled": true,
        "brandImageUrl": "<string>",
        "services": [
          {
            "id": "<string>",
            "name": "<string>",
            "durationMinutes": 123,
            "price": 123,
            "providerIds": [
              "<string>"
            ],
            "locationIds": [
              "<string>"
            ],
            "maxAttendees": 123,
            "type": "individual",
            "description": "<string>",
            "category": "<string>",
            "itemCode": "<string>"
          }
        ],
        "locations": [
          {
            "id": "<string>",
            "name": "<string>",
            "address": {
              "line1": "<string>",
              "line2": "<string>",
              "suburb": "<string>",
              "city": "<string>",
              "state": "<string>",
              "postcode": "<string>",
              "country": "<string>",
              "countryCode": "<string>"
            },
            "businessId": "<string>"
          }
        ],
        "providers": [
          {
            "id": "<string>",
            "locationIds": [
              "<string>"
            ],
            "firstName": "<string>",
            "lastName": "<string>"
          }
        ],
        "bookingSettings": {
          "notesEnabled": true,
          "cancellationFeeEnabled": true,
          "cancellationFeeAutoChargeEnabled": true,
          "paymentDetailsRequired": true,
          "bookingNotificationsEnabled": true,
          "providerBookingNotificationsEnabled": true,
          "healthFundCardCollectionEnabled": true,
          "cancellationFeeAmount": 100,
          "cancellationFeePercent": 10,
          "cancellationNoFeeBeforeHours": 24,
          "googleTagManagerContainerId": "GTM-123456"
        },
        "businesses": [
          {
            "id": "<string>",
            "capabilities": [
              {
                "id": "bookings_client_management",
                "status": "inactive"
              }
            ]
          }
        ]
      },
      "firstName": "<string>",
      "lastName": "<string>",
      "profileImageUrl": "<string>"
    }
  ],
  "page": 1,
  "limit": 10,
  "totalItems": 100,
  "totalPages": 10
}

Path Parameters

memberId
string
required
Example:

"mem_2yQwfVV3QvbDHdOBIZlCCf0956V"

Query Parameters

page
number
default:1

Page number

Required range: 1 <= x <= 9007199254740991
Example:

1

limit
number
default:10

Number of items per page

Required range: 1 <= x <= 200
Example:

10

Response

200 - application/json
items
object[]
page
number
Example:

1

limit
number
Example:

10

totalItems
number
Example:

100

totalPages
number
Example:

10