@microfox/slack
Version:
This package provides a lightweight, proxy interface to the official Slack Web API, offering a curated set of the most commonly used functions for building Slack integrations. It is designed to be simple, efficient, and easy to integrate into your project
224 lines (223 loc) • 7.26 kB
JSON
{
"post": {
"operationId": "getUsersByEmails",
"summary": "Searches for multiple Slack users by their email addresses.",
"description": "Finds multiple users in a Slack workspace using their email addresses. Returns an array of comprehensive user objects containing detailed information about the found users.",
"tags": [
"user"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"body": {
"type": "object",
"description": "Body of the getUsersByEmails sls call",
"properties": {
"arguments": {
"type": "object",
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of email addresses for the users to find."
}
},
"required": [
"emails"
]
}
},
"required": [
"arguments"
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"team_id": {
"type": "string"
},
"name": {
"type": "string"
},
"deleted": {
"type": "boolean"
},
"color": {
"type": "string"
},
"real_name": {
"type": "string"
},
"tz": {
"type": "string"
},
"tz_label": {
"type": "string"
},
"tz_offset": {
"type": "integer"
},
"profile": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"phone": {
"type": "string"
},
"skype": {
"type": "string"
},
"real_name": {
"type": "string"
},
"real_name_normalized": {
"type": "string"
},
"display_name": {
"type": "string"
},
"display_name_normalized": {
"type": "string"
},
"fields": {
"type": "object"
},
"status_text": {
"type": "string"
},
"status_emoji": {
"type": "string"
},
"status_expiration": {
"type": "integer"
},
"avatar_hash": {
"type": "string"
},
"start_date": {
"type": "string"
},
"image_original": {
"type": "string"
},
"is_custom_image": {
"type": "boolean"
},
"email": {
"type": "string"
},
"pronouns": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"image_24": {
"type": "string"
},
"image_32": {
"type": "string"
},
"image_48": {
"type": "string"
},
"image_72": {
"type": "string"
},
"image_192": {
"type": "string"
},
"image_512": {
"type": "string"
},
"image_1024": {
"type": "string"
},
"status_text_canonical": {
"type": "string"
},
"team": {
"type": "string"
}
}
},
"is_admin": {
"type": "boolean"
},
"is_owner": {
"type": "boolean"
},
"is_primary_owner": {
"type": "boolean"
},
"is_restricted": {
"type": "boolean"
},
"is_ultra_restricted": {
"type": "boolean"
},
"is_bot": {
"type": "boolean"
},
"is_app_user": {
"type": "boolean"
},
"updated": {
"type": "string"
},
"is_email_confirmed": {
"type": "boolean"
},
"who_can_share_contact_card": {
"type": "string"
},
"enterprise_user": {
"type": "object"
}
}
}
}
}
}
}
},
"400": {
"description": "Bad request - invalid email format or missing email"
},
"404": {
"description": "User not found"
},
"500": {
"description": "Server error"
}
}
}
}