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
  • Request
  • Response
  • cURL Request Example
  • Response Example

Read Profile Information

This method allows reading the information of the user. It includes premium status, channel, and login(can be an email).

Request

name
value

url

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

method

GET

scope

profile:read

Response

name
type
description

channel

string

User's channel e.g. twitch.tv/pulsoid

username

string

Username e.g. pulsoid, support@pulsoid.net

mobile_login

boolean

Indicates whether user did login via mobile client

heart_rate

boolean

Indicates whether user transmit any heart rate data

cURL Request Example

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

Response Example

{
	"channel": "twitch.tv/pulsoid",
	"login": "support@pulsoid.net"
	"mobile_login": true,
	"heart_rate": true
}

PreviousUpdate WidgetNextError Code Format

Last updated 1 year ago