| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://www.beeminder.com/api/v1/ | link | — | — | — |
Actions (22)
Users · 13
- Call 'Uncle' (instant derail)POST /users/{u}/goals/{g}/uncleme.json
Instant derail of the goal (derail) by paying the pledge.
documented - Cancel a scheduled step downPOST /users/{u}/goals/{g}/cancel_stepdown.json
Cancel a pending stepdown of the pledge.
documented - Create a goal for a userPOST /users/{u}/goals.json
Create a new Beeminder goal for user {u} with the provided parameters.
documented - Dial road (deprecated)POST /users/{u}/goals/{g}/dial_road.json
Deprecated: adjust the bright red line for a goal.
documented - Get authenticated user informationGET /users/me.json
Retrieve information about the currently authenticated user.
documented - Get goal informationGET /users/{u}/goals/{g}.json
Return the goal object for slug {g} under user {u}.
documented - Get user informationGET /users/{u}.json
Retrieve information about user {u}, including their profile and goals.
documented - List archived user goalsGET /users/{u}/goals/archived.json
Return archived goals for user {u}.
documented - List user goalsGET /users/{u}/goals.json
Return all Beeminder goals for user {u}.
documented - Refresh a goal's graph and autodataGET /users/{u}/goals/{g}/refresh_graph.json
Force a fetch of autodata and graph refresh for the specified goal.
documented - Short circuit a goal's pledgePOST /users/{u}/goals/{g}/shortcircuit.json
Increase the pledge and derail the goal immediately.
documented - Step down a goal's pledgePOST /users/{u}/goals/{g}/stepdown.json
Initiate a scheduled stepdown of the goal's pledge.
documented - Update a user goalPUT /users/{u}/goals/{g}.json
Update a user’s goal (goal_type cannot be changed with this endpoint).
documented
Goals · 5
- Create a datapointPOST /users/{u}/goals/{g}/datapoints.json
Add a single datapoint to the given goal.
documented - Create multiple datapointsPOST /users/{u}/goals/{g}/datapoints/create_all.json
Create multiple datapoints for the given goal in one request.
documented - Delete a datapointDELETE /users/{u}/goals/{g}/datapoints/{id}.json
Delete a datapoint from the given goal.
documented - Get all datapointsGET /users/{u}/goals/{g}/datapoints.json
Retrieve datapoints for the given goal.
documented - Update a datapointPUT /users/{u}/goals/{g}/datapoints/{id}.json
Update an existing datapoint (by ID) for the given goal.
documented