# Overview The Fitbit Plus API is a RESTful API. The requests and responses are formated according to the [JSON API](http://jsonapi.org/format/1.0/) specification. In addition to this documentation, we also provide an [OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.m
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.twinehealth.com/pub
auth: o a u t h 2
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
# Overview The Fitbit Plus API is a RESTful API. The requests and responses are formated according to the [JSON API](http://jsonapi.org/format/1.0/) specification. In addition to this documentation, we also provide an [OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) "yaml" file describing the API: [Fitbit Plus API Specification](swagger.yaml). # Authentication
| method | path | what the vendor says it does |
|---|---|---|
POST | /action | Create action Create a plan action action |
GET | /action/{id} | Get an action Get a health action from a patient's plan. action |
PATCH | /action/{id} | Update an action Update a health action from a patient's plan. action |
POST | /bundle | Create bundle Create a bundle in a patient's plan bundle |
GET | /bundle/{id} | Get a bundle Get a bundle from a patient's plan. bundle |
PATCH | /bundle/{id} | Update a bundle Updte a bundle from a patient's plan. bundle |
GET | /calendar_event | List calendar events Get a list of calendar events calendar event |
POST | /calendar_event | Create calendar event Create a calendar event for a patient. Attribute `all_day` must be set to `true` and `en |
GET | /calendar_event/{id} | Get a calendar event Get a calendar event by id calendar event |
PATCH | /calendar_event/{id} | Update a calendar event Update a calendar event for a patient. Attribute `all_day` must be true and `end_at` c |
DELETE | /calendar_event/{id} | Delete a calendar event Delete a calendar event by id calendar event |
POST | /calendar_event_response | Create calendar event response Create a calendar event response for an attendee of a calendar event, the atten |
GET | /coach | List coaches Get a list of coaches matching the specified filters. coach |
GET | /coach/{id} | Get a coach Get a coach record by id. coach |
GET | /email_history | List email histories Get a list of email histories email history |
GET | /email_history/{id} | Get an email history Get an email history by id email history |
GET | /group | List groups Get a list of groups matching the specified filters. group |
POST | /group | Create a group Create a group record. group |
GET | /group/{id} | Get a group Get a group record by id. group |
GET | /health_profile | List health profiles Get a list of health profiles health profile |
GET | /health_profile/{id} | Get a health profile Get a health profile by id health profile |
GET | /health_profile_answer | List health profile answers Get a list of health profile answers health profile answer |
GET | /health_profile_answer/{id} | Get a health profile answer Get a health profile answer by id health profile answer |
GET | /health_profile_question | List health profile questions Get a list of health profile questions health profile question |
GET | /health_profile_question/{id} | Get a health profile question Get a health profile by id health profile question |
GET | /health_question_definition | List health question definitions Get a list of all health question definitions health question definition |
GET | /health_question_definition/{id} | Get a health question definition Get a health question definition by id health question definition |
POST | /oauth/token | Create an oauth token Create an OAuth 2.0 Bearer token. A valid bearer token is required for all other API req |
GET | /oauth/token/{id}/groups | Get the groups for a token Get the list of groups a token can be used to access. oauth |
GET | /oauth/token/{id}/organization | Get the organization for a token Get the organization a token can be used to access. oauth |
GET | /organization/{id} | Get an organization Get an organization record by id. organization |
GET | /patient | List patients Get a list of patients. patient |
POST | /patient | Create a patient Create a patient record. Example for creating a patient with a group specified using `meta.q |
PUT | /patient | Upsert patient Create a new patient or update an existing patient patient |
GET | /patient/{id} | Get a patient Gets a patient record by id. patient |
PATCH | /patient/{id} | Update a patient Update a patient record. patient |
GET | /patient/{id}/coaches | List coaches for a patient Get the list of coaches for a patient. patient |
GET | /patient/{id}/groups | List groups for a patient Get the list of groups for a patient. patient |
GET | /patient_health_metric | List patient health metrics Get a list of patient health metrics. metric |
POST | /patient_health_metric | Create patient health metrics Create one or more patient health metrics. Example for creating a patient healt |
and 22 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/TwineHealth/TwineDeveloperDocs/master/spec/swagger.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.