Slack: Find a user with an email address

Slack users.lookupByEmail: arguments, response, policy and SDK examples.

Operation slack.users_lookupbyemail

Provider route: GET /users.lookupByEmail. 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"]["lookupByEmail"]>[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.lookupByEmail(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.lookup_by_email(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`query`	object	Required within parent	Additional keys: not allowed
`query.email`	string	Required within parent

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.lookupByEmail method Additional keys: allowed
`ok`	boolean	Required within parent	Must equal: true
`user`	Model	Optional	Expand Gets information about a user — response body — user

Referenced models: Gets information about a user — response body — user

Schemas

1 more schema is linked from the tables above, on the schema pages.

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
`$`	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

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

Field	Type	Presence
`$`	object	Root
`is_custom`	JSON	Optional
`is_custom (anyOf 1)`	null	Alternative
`is_custom (anyOf 2)`	boolean	Alternative
`is_multiple_entry`	JSON	Optional
`is_multiple_entry (anyOf 1)`	null	Alternative
`is_multiple_entry (anyOf 2)`	boolean	Alternative
`is_protected`	JSON	Optional
`is_protected (anyOf 1)`	null	Alternative
`is_protected (anyOf 2)`	boolean	Alternative
`is_scim`	JSON	Optional
`is_scim (anyOf 1)`	null	Alternative
`is_scim (anyOf 2)`	boolean	Alternative

Policy, approvals and errors

SDK function policy ID: slack.users_lookupbyemail. Catalog operation: users_lookupByEmail. 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.email"]

Official provider source

Report an issue with this page