MyMenopauseRxfor developers
API Reference

List bookable appointment types across the public provider roster.

Returns the distinct enabled appointment types, each annotated with the US states it is offered in and whether new patients may book it. Pass `state` to restrict the catalog (and each type's reported `states`) to a single state. Responses are publicly cacheable and support `ETag`/`If-None-Match`.

GET
/v1/appointment-types

Returns the distinct enabled appointment types, each annotated with the US states it is offered in and whether new patients may book it. Pass state to restrict the catalog (and each type's reported states) to a single state. Responses are publicly cacheable and support ETag/If-None-Match.

Path Parameters

state*|

Optional US state to filter by, as a 2-letter code or full state name (case-insensitive, e.g. CA or California). Omit to return the full catalog across all states.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/appointment-types"
{
  "appointmentTypes": [
    {
      "description": "A 30-minute video visit to review symptoms and build a plan.",
      "id": 0,
      "modality": "video",
      "name": "Initial Menopause Consult",
      "newPatientEligible": true,
      "states": [
        "CA",
        "TX"
      ]
    }
  ],
  "state": "CA"
}
Empty
{
  "code": "SPONSOR_NOT_COVERED",
  "message": "invalid state code: ZZ"
}
{
  "code": "SPONSOR_NOT_COVERED",
  "message": "invalid state code: ZZ"
}