Get user presence | Sample

2 parameters

tokenstringrequired

Authentication token with the `users:read` scope.

userstringoptional

User ID whose presence to retrieve; defaults to the authenticated user when omitted.

2 status codes

200Returns the requested user's presence, including the required `presence` value and, where available, online, away, connection, and activity information.

auto_awaybooleanoptional

connection_countintegeroptional

last_activityintegeroptional

manual_awaybooleanoptional

okbooleanrequired

Allowed:true

onlinebooleanoptional

presencestringrequired

defaultTypical error response

errorstringrequired

okbooleanrequired

Allowed:false

Error handling

An authentication token with the users:read scope is required. When user is provided, it must identify the user whose presence you want to retrieve; otherwise the authenticated user's presence is returned.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.usersGetPresence.list({
  token: "sk_live_4eC39Hq",
  user: "octocat",
});

{
  "ok": true,
  "presence": "active"
}

Request

Response

Errors