Slack: Gets user presence information

← Users operations · Get started

Operation slack.users_getpresence

Provider route: GET /users.getPresence. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/slack with npm, or alter-sdk-slack with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SlackIntegration } from "@alter-ai/slack";

async function execute(input: Parameters<SlackIntegration["users"]["getPresence"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new SlackIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.users.getPresence(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_slack import SlackIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = SlackIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.users.get_presence(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.user	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root	Generated from users.getPresence with shasum e7251aec575d8863f9e0eb38663ae9dc26655f65 Additional keys: allowed
auto_away	boolean	Optional
connection_count	JSON	Optional
connection_count (anyOf 1)	integer	Alternative
connection_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
last_activity	JSON	Optional
last_activity (anyOf 1)	integer	Alternative
last_activity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
manual_away	boolean	Optional
ok	boolean	Required within parent	Must equal: true
online	boolean	Optional
presence	string	Optional

Policy, approvals and errors

SDK function policy ID: slack.users_getpresence. Catalog operation: users_getPresence. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["users:read"]

Official provider source