Tether Docs

GET /v1/users/{userID}

Retrieve a presence snapshot for a single user.


Overview

Returns the latest presence snapshot for a given Discord user ID. This endpoint mirrors the behaviour of the local SnapshotHandler used in the server.

Info

The presence data model returned by this endpoint is consistent with WebSocket events. See Data Models for the full schema and field documentation.

Request

MethodPathDescription
GET/v1/users/{userID}Get presence for a user
ParameterTypeDescription
userIDstringDiscord user ID to fetch

Example:

GET https://tether.eggwite.moe/v1/users/{userID}

Responses

StatusDescription
200Success; returns presence payload
400Missing or invalid userID
404User not found in presence store

Example Success Response

200 OK
{
  "success": true,
  "data": {
    "user_id": "1447110828783566973",
    "data": { /* see Data Models for schema */ }
  }
}

Note

The data field contains a presence object. For a detailed breakdown of all fields, see Presence Data Model.

Example Error Response

404 Not Found
{
  "success": false,
  "error": {
    "code": "USER_NOT_FOUND",
    "message": "User is not being monitored by Tether",
    "status": 404,
    "retryable": false,
    "details": null
  }
}

Tip

  • The server returns 400 if userID is empty or invalid.
  • A 404 is returned if the user is not tracked by the presence store.
  • For rate limits and error envelope details, see Rate Limits and Error Codes.

Last updated:

On this page