For AI agents: visit https://developer.bwell.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Guides API Reference Changelog

API Reference

bwell User Data Operations

/users/{id}/data-exports
- Initiate user data exportpost
/users/{id}
- Initiate user data deletiondel

Client Webhook API

Webhooks
/webhook
- Receive a bwell webhook eventpost

TypeScript SDK Overview

API Reference Overview

TypeScript SDK Core

TypeScript SDK Core

TypeScript SDK Managers

ConnectionManager
DeviceManager
FinancialManager
HealthManager
HealthSpaceManager
LanguageManager
QuestionnaireManager
SearchManager
UserManager

TypeScript SDK Requests

TypeScript SDK Models

TypeScript SDK Enums

CategoryCode
ConnectionCategory
ConsentProvisionType
ConsentStatus
DataConnectionStatus
DataConnectionType
DevicePlatform
EndpointStatus
FilterField
Gender
LogLevel
PersonGender
SearchContext
SearchResultType
SortField
SortOrder
SyncStatus

TypeScript SDK Inputs

AppointmentsRequestInput
CancelAppointmentRequestInput
CancellationReasonsRequestInput
ConnectionRequestInput
CoverageRequestInput
CreateConsentRequestInput
CreateDataExportDirectDownloadUrlRequestInput
CreateVerificationUrlRequestInput
DataSourceRequestInput
DeregisterDeviceRequestInput
ExplanationOfBenefitRequestInput
FieldSortOrder
GetConsentsRequestInput
HealthDataRequestInput
LabKnowledgeRequestInput
MedicationKnowledgeRequestInput
NextQuestionRequestInput
OrderBy
PagedRequestInput
RegisterDeviceRequestInput
SearchDate
SearchDateValue
SearchHealthResourcesRequestInput
SearchPosition
SearchString
SearchToken
SearchTokenValue
SubmitProviderForReviewRequestInput
UpdateProfileRequestInput

TypeScript SDK Errors

AuthenticationError
BWellError
BWellErrorOptions
IllegalArgumentError
IllegalStateError
InvalidClientKeyError
InvalidCredentialsTypeError
InvalidTokenError
NetworkError
OperationOutcomeError
UnknownError
ValidationError

TypeScript SDK Other

BWellConfig
BWellQueryResult
BWellTransactionFailure
BWellTransactionResult
BWellTransactionSuccess
InMemoryTokenStorage
TokenStorage

BWellErrorOptions

Options for BWellError constructor

BWellErrorOptions = object

Options for BWellError constructor

Properties

cause

cause: unknown

Updated 8 months ago

IllegalArgumentError

Did this page help you?

Updated 8 months ago

IllegalArgumentError

Did this page help you?

- Properties
- - cause