Pulsoid API Documentation
DashboardRequest CredentialsDiscord
  • Intro
  • Access Token Management
    • OAuth2 Implicit Grant
    • OAuth2 Authorization Code Grant
    • OAuth2 Client Credentials Grant Type(server token)
    • Manual Token Issuing
    • OAuth2 Refreshing the token
    • Revoke authorization token
    • Validate authorization token
    • List of supported scopes
  • Read Heart Rate
    • Read Latest Heart Rate via HTTP
    • Read Heart Rate via WebSocket
    • Page
    • Read Statistics
  • Widgets Management
    • Widget Entity
    • Create Widget
    • Read Widget
    • Update Widget
  • Read Profile Information
  • Error Code Format
  • VRChat
    • VRChat World Integration
Powered by GitBook
On this page
  1. Widgets Management

Read Widget

PreviousCreate WidgetNextUpdate Widget

Last updated 6 months ago

This method allows reading the information of the user's widgets.

Request

name
value

url

https://dev.pulsoid.net/api/v1/widgets

method

GET

scope

widgets:read

Headers Parameters explained:

name
value
description

Authorization

Bearer {auth token}

Response

The response is an array of objects. Each object represents a .

Curl Request Example

curl --request GET \
  --url https://pulsoid.net/api/v1/widgets \
  --header 'Authorization: Bearer 8c4da3ce-7ed7-4a19-a1f1-058498661e45'

Response Example

{
  "widgets": [
    {
      "id": "40b0131e-fe68-4020-90a0-1a5eb78fd9b4",
      "meta_id": "b828337f-cdb0-49d2-8e55-9b1285cd0d22",
      "configuration": {},
      "name": "Some name"
    },
    {
      "id": "95680ad2-8d19-44fe-996c-280db1bd6bf1",
      "meta_id": "f0654a12-3a59-4beb-b567-c5febda19c48",
      "configuration": {
        "ranges": [
          {
            "to": 90,
            "from": 60,
            "color": "#04bbafff"
          },
          {
            "to": 100,
            "from": 91,
            "color": "#fdb008ff"
          }
        ],
        "heartColor": "#f72d21ff",
        "heartEnabled": true
      },
      "name": "Widget 2"
    }
  ]
}

How to obtains access token

widget
https://docs.pulsoid.net/#how-to-obtain-an-authorization-token