Skip to main content
GET
/
v1
/
members
/
{memberId}
/
bookings
List member bookings
curl --request GET \
  --url https://api.halth.com/v1/members/{memberId}/bookings
{
  "items": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "serviceDate": "2023-11-07T05:31:56Z",
      "paid": true,
      "organisation": {
        "id": "<string>",
        "name": "<string>",
        "brandImageUrl": "<string>"
      },
      "location": {
        "id": "<string>",
        "address": {}
      },
      "provider": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "profileImageUrl": "<string>"
      },
      "appointmentType": {
        "id": "<string>",
        "name": "<string>",
        "durationMinutes": 123
      },
      "servicePrice": 123,
      "cancellationPolicy": {
        "enabled": true,
        "rules": {
          "clientCancel": {
            "enabled": true,
            "reason": "booking_paid"
          },
          "clientReschedule": {
            "enabled": true,
            "reason": "booking_paid"
          }
        },
        "fee": {
          "amount": 123,
          "freeCancellationHours": 123,
          "latestNoFeeAt": "2023-11-07T05:31:56Z",
          "billable": true,
          "percent": 123
        }
      }
    }
  ],
  "page": 1,
  "limit": 10,
  "totalItems": 100,
  "totalPages": 10
}

Path Parameters

memberId
string
required

The unique identifier of the member

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

serviceDateMin
string<date-time>
status
enum<string>[]
Available options:
confirmed,
cancelled
paid
boolean
expand
enum<string>[]
Available options:
cancellationPolicy

Response

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

1

limit
number
Example:

10

totalItems
number
Example:

100

totalPages
number
Example:

10