Slack: Lists all users in a Slack team

← Users operations · Get started

Operation slack.users_list

Provider route: GET /users.list. 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"]["list"]>[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.list(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.list(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.cursor	string	Optional
query.include_locale	boolean	Optional
query.limit	number	Optional
query.team_id	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	Schema for successful response from users.list method
cache_ts	JSON	Optional
cache_ts (anyOf 1)	integer	Alternative
cache_ts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
members	array	Optional
members[]	Model	Each item	Expand Gets information about a user — response body — user
ok	boolean	Required within parent	Must equal: true
response_metadata	Model	Optional	Expand Gets information about a file — response body — response metadata

Referenced models: Gets information about a file — response body — response metadata, Gets information about a user — response body — user

Schemas

2 more schemas are linked from the tables above, on the schema pages.

Gets information about a file — response body — response metadata

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative
$ (anyOf 1).next_cursor	string	Optional
$ (anyOf 2)	object	Alternative
$ (anyOf 2).messages	array	Optional
$ (anyOf 2).messages[]	string	Each item
$ (anyOf 2).warnings	array	Optional
$ (anyOf 2).warnings[]	string	Each item	Known values: method_deprecated
$ (anyOf 3)	object	Alternative
$ (anyOf 3).messages	array	Optional
$ (anyOf 3).messages[]	string	Each item
$ (anyOf 3).next_cursor	string	Optional
$ (anyOf 3).warnings	array	Optional
$ (anyOf 3).warnings[]	string	Each item	Known values: method_deprecated

Gets information about a user — response body — user

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	user object for non enterprise type
$ (anyOf 1).color	string	Optional
$ (anyOf 1).deleted	boolean	Optional
$ (anyOf 1).enterprise_user	Model	Optional	Expand Gets information about a user — response body — user enterprise user enterprise user
$ (anyOf 1).has_2fa	boolean	Optional
$ (anyOf 1).id	string	Optional
$ (anyOf 1).is_admin	boolean	Optional
$ (anyOf 1).is_app_user	boolean	Optional
$ (anyOf 1).is_bot	boolean	Optional
$ (anyOf 1).is_external	boolean	Optional
$ (anyOf 1).is_forgotten	boolean	Optional
$ (anyOf 1).is_invited_user	boolean	Optional
$ (anyOf 1).is_owner	boolean	Optional
$ (anyOf 1).is_primary_owner	boolean	Optional
$ (anyOf 1).is_restricted	boolean	Optional
$ (anyOf 1).is_stranger	boolean	Optional
$ (anyOf 1).is_ultra_restricted	boolean	Optional
$ (anyOf 1).locale	string	Optional
$ (anyOf 1).name	string	Optional
$ (anyOf 1).presence	string	Optional
$ (anyOf 1).profile	Model	Optional	Expand Retrieve a user's profile information, including their custom status — response body — profile
$ (anyOf 1).real_name	string	Optional
$ (anyOf 1).team	string	Optional
$ (anyOf 1).team_id	string	Optional
$ (anyOf 1).team_profile	object	Optional
$ (anyOf 1).team_profile.fields	array	Optional
$ (anyOf 1).team_profile.fields[]	Model	Each item	Expand Retrieve a team's profile — response body — profile fields item
$ (anyOf 1).two_factor_type	string	Optional
$ (anyOf 1).tz	JSON	Optional
$ (anyOf 1).tz (anyOf 1)	null	Alternative
$ (anyOf 1).tz (anyOf 2)	string	Alternative
$ (anyOf 1).tz_label	string	Optional
$ (anyOf 1).tz_offset	JSON	Optional
$ (anyOf 1).tz_offset (anyOf 1)	number	Alternative
$ (anyOf 1).tz_offset (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).updated	JSON	Optional
$ (anyOf 1).updated (anyOf 1)	number	Alternative
$ (anyOf 1).updated (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2)	object	Alternative	enterprise user
$ (anyOf 2).color	string	Optional	refercing to bug: https://jira.tinyspeck.com/browse/EVALUE-1559
$ (anyOf 2).deleted	boolean	Optional
$ (anyOf 2).enterprise_user	Model	Optional	Expand Gets information about a user — response body — user enterprise user enterprise user
$ (anyOf 2).has_2fa	boolean	Optional
$ (anyOf 2).id	string	Optional
$ (anyOf 2).is_admin	boolean	Optional
$ (anyOf 2).is_app_user	boolean	Optional
$ (anyOf 2).is_bot	boolean	Optional
$ (anyOf 2).is_external	boolean	Optional
$ (anyOf 2).is_forgotten	boolean	Optional
$ (anyOf 2).is_owner	boolean	Optional
$ (anyOf 2).is_primary_owner	boolean	Optional
$ (anyOf 2).is_restricted	boolean	Optional
$ (anyOf 2).is_stranger	boolean	Optional
$ (anyOf 2).is_ultra_restricted	boolean	Optional
$ (anyOf 2).locale	string	Optional
$ (anyOf 2).name	string	Optional
$ (anyOf 2).presence	string	Optional
$ (anyOf 2).profile	Model	Optional	Expand Retrieve a user's profile information, including their custom status — response body — profile
$ (anyOf 2).real_name	string	Optional
$ (anyOf 2).team_id	string	Optional
$ (anyOf 2).team_profile	object	Optional
$ (anyOf 2).team_profile.fields	array	Optional
$ (anyOf 2).team_profile.fields[]	Model	Each item	Expand Retrieve a team's profile — response body — profile fields item
$ (anyOf 2).teams	array	Optional
$ (anyOf 2).teams[]	string	Each item
$ (anyOf 2).two_factor_type	string	Optional
$ (anyOf 2).tz	JSON	Optional
$ (anyOf 2).tz (anyOf 1)	null	Alternative
$ (anyOf 2).tz (anyOf 2)	string	Alternative
$ (anyOf 2).tz_label	string	Optional
$ (anyOf 2).tz_offset	JSON	Optional
$ (anyOf 2).tz_offset (anyOf 1)	number	Alternative
$ (anyOf 2).tz_offset (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2).updated	JSON	Optional
$ (anyOf 2).updated (anyOf 1)	number	Alternative
$ (anyOf 2).updated (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Gets information about a user — response body — user enterprise user enterprise user, Retrieve a team's profile — response body — profile fields item, Retrieve a user's profile information, including their custom status — response body — profile

Gets information about a user — response body — user enterprise user enterprise user

Field	Type	Presence	Description and constraints
$	object	Root
enterprise_id	string	Optional
enterprise_name	string	Optional
id	string	Optional
is_admin	boolean	Optional
is_owner	boolean	Optional
teams	array	Optional
teams[]	string	Each item

Retrieve a team's profile — response body — profile fields item

Field	Type	Presence	Description and constraints
$	object	Root
field_name	JSON	Optional
field_name (anyOf 1)	null	Alternative
field_name (anyOf 2)	string	Alternative
hint	string	Optional
id	string	Optional
is_hidden	boolean	Optional
label	string	Optional
options	JSON	Optional
options (anyOf 1)	null	Alternative
options (anyOf 2)	Model	Alternative	Expand Retrieve a team's profile — response body — profile fields item options is custom, is multiple entry, is protected, is scim
ordering	JSON	Optional
ordering (anyOf 1)	number	Alternative
ordering (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
possible_values	JSON	Optional
possible_values (anyOf 1)	null	Alternative
possible_values (anyOf 1)[]	string	Each item
possible_values (anyOf 2)	array	Alternative
possible_values (anyOf 2)[]	string	Each item
type	string	Optional	Known values: text, date, link, mailto, options_list, user

Referenced models: Retrieve a team's profile — response body — profile fields item options is custom, is multiple entry, is protected, is scim

Policy, approvals and errors

SDK function policy ID: slack.users_list. Catalog operation: users_list. 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