Get user details

GET 
https://whatpulse.test/api/v1/users/:id

Get detailed information about a specific user. Returns public profile information that can be viewed by anyone, or private information if you're viewing your own profile or have the appropriate permissions.

Request

Path Parameters

id stringrequired

User ID or username

Responses

200

UserResource

application/json

Schema

Schema

anyOf
MOD1
user objectrequired
idintegerrequired
The unique identifier for the user.
usernamestringrequired
The username of the user.
date_joinedstringrequired
The date the user joined WhatPulse, in ISO 8601 format.
first_pulse_datestring | nullnullablerequired
The date of the first pulse, in ISO 8601 format.
last_pulse_datestring | nullnullablerequired
The date of the last pulse, in ISO 8601 format.
pulsesintegerrequired
The total number of pulses sent by the user.
team_idinteger | nullnullablerequired
The ID of the team the user is part of, if any.
team_is_managerbooleanrequired
Whether the user is a manager of their team.
country_idintegerrequired
The country ID of the user, used for geographical information.
is_premiumbooleanrequired
Whether the user is an active premium member.
referralsintegerrequired
The number of referrals the user has made.
last_referral_datestring | nullnullablerequired
The date of the last referral, in ISO 8601 format.
avatarstring | nullnullablerequired
The user's avatar URL.
totals objectrequired
keysintegerrequired
The total number of keys pressed by the user.
clicksintegerrequired
The total number of mouse clicks made by the user.
download_mbnumberrequired
The total amount of data downloaded by the user, in megabytes.
upload_mbnumberrequired
The total amount of data uploaded by the user, in megabytes.
uptime_secondsintegerrequired
The total uptime the user has recorded, in seconds.
scrollsintegerrequired
The total number of mouse scrolls recorded for the user.
distance_milesnumberrequired
The total distance the mouse has moved in miles on this computer.
ranks objectrequired
keysintegerrequired
The user's rank based on the total number of keys pressed.
clicksintegerrequired
The user's rank based on the total number of mouse clicks.
downloadintegerrequired
The user's rank based on the total amount of data downloaded, in megabytes.
uploadintegerrequired
The user's rank based on the total amount of data uploaded, in megabytes.
uptimeintegerrequired
The user's rank based on the total uptime recorded, in seconds.
scrollsintegerrequired
The user's rank based on the total number of mouse scrolls.
distanceintegerrequired
The user's rank based on the total distance the mouse has moved in miles.
include_in_rankingsbooleanrequired
Whether the user is included in rankings.
distance_systemstringrequired
The system used for measuring distance (miles or kilometers).
Possible values: [metric, imperial, auto]
last_pulse objectnullrequired
datestringrequired
The date of the last pulse, in ISO 8601 format.
keysintegerrequired
The number of keys pressed in the last pulse.
clicksintegerrequired
The number of mouse clicks in the last pulse.
download_mbnumberrequired
The amount of data downloaded in the last pulse, in megabytes.
upload_mbnumberrequired
The amount of data uploaded in the last pulse, in megabytes.
uptime_secondsintegerrequired
The uptime recorded in the last pulse, in seconds.
scrollsintegerrequired
The number of mouse scrolls recorded in the last pulse.
distance_milesnumberrequired
The distance the mouse has moved in miles during the last pulse.
MOD2
object

Example (auto)

{
  "user": {
    "id": 0,
    "username": "string",
    "date_joined": "string",
    "pulses": 0,
    "team_is_manager": true,
    "country_id": 0,
    "is_premium": true,
    "referrals": 0,
    "totals": {
      "keys": 0,
      "clicks": 0,
      "download_mb": 0,
      "upload_mb": 0,
      "uptime_seconds": 0,
      "scrolls": 0,
      "distance_miles": 0
    },
    "ranks": {
      "keys": 0,
      "clicks": 0,
      "download": 0,
      "upload": 0,
      "uptime": 0,
      "scrolls": 0,
      "distance": 0
    },
    "include_in_rankings": true,
    "distance_system": "metric"
  }
}

401

Unauthenticated

application/json

Schema

Schema

messagestringrequired

Error overview.

Example (auto)

{
  "message": "string"
}

422

Validation error

application/json

Schema

Schema

messagestringrequired

Errors overview.

errors objectrequired
A detailed description of each field that failed validation.
property name* string[]
Array [
string
]

Example (auto)

{
  "message": "string",
  "errors": {}
}

Authorization: http

name: httptype: httpscheme: bearer

• go
• java
• javascript
• kotlin
• nodejs
• objective-c
• php
• powershell
• python
• r
• ruby
• rust
• swift

• NATIVE

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://whatpulse.test/api/v1/users/:id"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer <token>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

Request Collapse all

Base URL

https://whatpulse.test/api/v1

Auth

Bearer Token

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!