Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://slack.com/api
No endpoints found for this provider.
blocks
{
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
}
},
"additionalProperties": true
},
"title": "Block Kit blocks",
"description": "This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace."
}
defs_app_id
{
"type": "string",
"title": "App ID",
"pattern": "^A[A-Z0-9]{1,}$"
}
defs_bot_id
{
"type": "string",
"title": "Bot User ID",
"pattern": "^B[A-Z0-9]{8,}$"
}
defs_channel
{
"type": "string",
"title": "Channel-like conversation ID",
"pattern": "^[CGD][A-Z0-9]{8,}$"
}
defs_channel_id
{
"type": "string",
"title": "Channel ID",
"pattern": "^[C][A-Z0-9]{2,}$"
}
defs_channel_name
{
"type": "string",
"title": "Name of a channel"
}
defs_comment_id
{
"type": "string",
"title": "File Comment ID",
"pattern": "^Fc[A-Z0-9]{8,}$"
}
defs_dm_id
{
"type": "string",
"title": "Direct Message Channel ID",
"pattern": "^[D][A-Z0-9]{8,}$"
}
defs_enterprise_id
{
"type": "string",
"title": "Enterprise ID",
"pattern": "^[E][A-Z0-9]{8,}$"
}
defs_enterprise_name
{
"type": "string",
"title": "Name of the enterprise org"
}
defs_enterprise_user_id
{
"type": "string",
"title": "Enterprise User ID",
"pattern": "^[WU][A-Z0-9]{8,}$"
}
defs_file_id
{
"type": "string",
"title": "File ID",
"pattern": "^[F][A-Z0-9]{8,}$"
}
defs_group_id
{
"type": "string",
"title": "Private Channel ID",
"pattern": "^[G][A-Z0-9]{8,}$"
}
defs_ok_false
{
"enum": [
false
],
"type": "boolean",
"title": "default failure response"
}
defs_ok_true
{
"enum": [
true
],
"type": "boolean",
"title": "default success response"
}
defs_optional_app_id
{
"type": "string",
"title": "App ID or empty string",
"pattern": "^(A[A-Z0-9]{1,})?$"
}
defs_pinned_info
{
"type": "object",
"title": "Info for a pinned item",
"additionalProperties": false
}
defs_reminder_id
{
"type": "string",
"title": "Reminder ID",
"pattern": "^Rm[A-Z0-9]{8,}$"
}
defs_subteam_id
{
"type": "string",
"title": "Subteam ID",
"pattern": "^S[A-Z0-9]{2,}$"
}
defs_team
{
"type": "string",
"title": "Team ID",
"pattern": "^[T][A-Z0-9]{2,}$"
}
defs_topic_purpose_creator
{
"type": "string",
"title": "User ID or empty string, used for topic and purpose creation",
"pattern": "^[UW][A-Z0-9]{8,}$|^$"
}
defs_ts
{
"type": "string",
"title": "Timestamp in format 0123456789.012345",
"pattern": "^\\d{10}\\.\\d{6}$"
}
defs_user_id
{
"type": "string",
"title": "User ID",
"pattern": "^[UW][A-Z0-9]{2,}$"
}
defs_workspace_id
{
"type": "string",
"title": "Team or Enterprise ID",
"pattern": "^[TE][A-Z0-9]{8,}$"
}
objs_bot_profile
{
"type": "object",
"title": "Bot Profile Object",
"required": [
"id",
"deleted",
"name",
"updated",
"app_id",
"icons",
"team_id"
],
"properties": {
"id": {
"$ref": "#/definitions/defs_bot_id"
},
"name": {
"type": "string"
},
"icons": {
"type": "object",
"required": [
"image_36",
"image_48",
"image_72"
],
"properties": {
"image_36": {
"type": "string",
"format": "uri"
},
"image_48": {
"type": "string",
"format": "uri"
},
"image_72": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
"app_id": {
"$ref": "#/definitions/defs_app_id"
},
"deleted": {
"type": "boolean"
},
"team_id": {
"$ref": "#/definitions/defs_team"
},
"updated": {
"type": "integer"
}
},
"additionalProperties": false
}
objs_channel
{
"type": "object",
"title": "Channel Object",
"required": [
"id",
"name",
"created",
"creator",
"is_channel",
"is_org_shared",
"is_private",
"is_mpim",
"is_shared",
"name_normalized",
"members",
"topic",
"purpose"
],
"properties": {
"id": {
"$ref": "#/definitions/defs_channel_id"
},
"name": {
"type": "string"
},
"topic": {
"type": "object",
"required": [
"value",
"creator",
"last_set"
],
"properties": {
"value": {
"type": "string"
},
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
}
},
"additionalProperties": false
},
"latest": {
"items": [
{
"$ref": "#/definitions/objs_message"
},
{
"type": "null"
}
]
},
"created": {
"type": "integer"
},
"creator": {
"$ref": "#/definitions/defs_user_id"
},
"is_mpim": {
"type": "boolean"
},
"members": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_user_id"
},
"minItems": 0,
"uniqueItems": true
},
"purpose": {
"type": "object",
"required": [
"value",
"creator",
"last_set"
],
"properties": {
"value": {
"type": "string"
},
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
}
},
"additionalProperties": false
},
"is_moved": {
"type": "integer"
},
"priority": {
"type": "number"
},
"unlinked": {
"type": "integer",
"title": "Field to determine whether a channel has ever been shared/disconnected in the past"
},
"is_frozen": {
"type": "boolean"
},
"is_member": {
"type": "boolean"
},
"is_shared": {
"type": "boolean"
},
"last_read": {
"$ref": "#/definitions/defs_ts"
},
"is_channel": {
"type": "boolean"
},
"is_general": {
"type": "boolean"
},
"is_private": {
"type": "boolean"
},
"is_archived": {
"type": "boolean"
},
"num_members": {
"type": "integer"
},
"is_read_only": {
"type": "boolean"
},
"unread_count": {
"type": "integer"
},
"accepted_user": {
"$ref": "#/definitions/defs_user_id"
},
"is_org_shared": {
"type": "boolean"
},
"is_thread_only": {
"type": "boolean"
},
"pending_shared": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"previous_names": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_channel_name"
},
"minItems": 0,
"uniqueItems": true
},
"name_normalized": {
"type": "string"
},
"is_non_threadable": {
"type": "boolean"
},
"unread_count_display": {
"type": "integer"
},
"is_pending_ext_shared": {
"type": "boolean"
}
},
"additionalProperties": false
}
objs_comment
{
"type": "object",
"title": "File Comment Object",
"required": [
"id",
"created",
"timestamp",
"user",
"is_intro",
"comment"
],
"properties": {
"id": {
"$ref": "#/definitions/defs_comment_id"
},
"user": {
"$ref": "#/definitions/defs_user_id"
},
"comment": {
"type": "string"
},
"created": {
"type": "integer"
},
"is_intro": {
"type": "boolean"
},
"num_stars": {
"type": "integer"
},
"pinned_to": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_channel"
}
},
"reactions": {
"type": "array",
"items": {
"$ref": "#/definitions/objs_reaction"
}
},
"timestamp": {
"type": "integer"
},
"is_starred": {
"type": "boolean"
},
"pinned_info": {
"$ref": "#/definitions/defs_pinned_info"
}
},
"additionalProperties": false
}
objs_comments
{
"type": "array",
"items": {},
"title": "file comments object"
}
objs_conversation
{
"items": [
{
"type": "object",
"title": "Conversation object",
"required": [
"id",
"name",
"created",
"creator",
"is_archived",
"is_channel",
"is_general",
"is_mpim",
"is_group",
"is_org_shared",
"is_im",
"is_shared",
"is_private",
"name_normalized",
"topic",
"purpose"
],
"properties": {
"id": {
"$ref": "#/definitions/defs_channel"
},
"name": {
"type": "string"
},
"user": {
"$ref": "#/definitions/defs_user_id"
},
"is_im": {
"type": "boolean"
},
"topic": {
"type": "object",
"required": [
"value",
"creator",
"last_set"
],
"properties": {
"value": {
"type": "string"
},
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
}
},
"additionalProperties": false
},
"latest": {
"items": [
{
"$ref": "#/definitions/objs_message"
},
{
"type": "null"
}
]
},
"shares": {
"type": "array",
"items": {
"type": "object",
"required": [
"team",
"user",
"is_active"
],
"properties": {
"team": {
"$ref": "#/definitions/objs_team"
},
"user": {
"$ref": "#/definitions/defs_user_id"
},
"is_active": {
"type": "boolean"
},
"accepted_user": {
"$ref": "#/definitions/defs_user_id"
}
},
"additionalProperties": false
},
"minItems": 0,
"uniqueItems": true
},
"created": {
"type": "integer"
},
"creator": {
"$ref": "#/definitions/defs_user_id"
},
"is_mpim": {
"enum": [
false
],
"type": "boolean"
},
"is_open": {
"type": "boolean"
},
"members": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_user_id"
},
"minItems": 0,
"uniqueItems": true
},
"purpose": {
"type": "object",
"required": [
"value",
"creator",
"last_set"
],
"properties": {
"value": {
"type": "string"
},
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
}
},
"additionalProperties": false
},
"version": {
"type": "integer"
},
"has_pins": {
"type": "boolean"
},
"is_group": {
"type": "boolean"
},
"is_moved": {
"type": "integer"
},
"priority": {
"type": "number"
},
"unlinked": {
"type": "integer",
"title": "Field to determine whether a channel has ever been shared/disconnected in the past"
},
"use_case": {
"type": "string"
},
"is_frozen": {
"type": "boolean"
},
"is_member": {
"type": "boolean"
},
"is_shared": {
"type": "boolean"
},
"last_read": {
"$ref": "#/definitions/defs_ts"
},
"pin_count": {
"type": "integer"
},
"is_channel": {
"type": "boolean"
},
"is_general": {
"type": "boolean"
},
"is_private": {
"type": "boolean"
},
"is_starred": {
"type": "boolean"
},
"is_archived": {
"type": "boolean"
},
"num_members": {
"type": "integer"
},
"is_read_only": {
"type": "boolean"
},
"unread_count": {
"type": "integer"
},
"accepted_user": {
"$ref": "#/definitions/defs_user_id"
},
"enterprise_id": {
"$ref": "#/definitions/defs_enterprise_id"
},
"is_ext_shared": {
"type": "boolean"
},
"is_org_shared": {
"type": "boolean"
},
"display_counts": {
"type": "object",
"required": [
"display_counts",
"guest_counts"
],
"properties": {
"guest_counts": {
"type": "integer"
},
"display_counts": {
"type": "integer"
}
},
"additionalProperties": false
},
"is_org_default": {
"type": "boolean"
},
"is_thread_only": {
"type": "boolean"
},
"pending_shared": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"previous_names": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_channel_name"
},
"minItems": 0,
"uniqueItems": true
},
"timezone_count": {
"type": "integer"
},
"name_normalized": {
"type": "string"
},
"shared_team_ids": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"is_global_shared": {
"type": "boolean"
},
"is_org_mandatory": {
"type": "boolean"
},
"internal_team_ids": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"is_non_threadable": {
"type": "boolean"
},
"connected_team_ids": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_workspace_id"
},
"minItems": 0,
"uniqueItems": true
},
"parent_conversation": {
"items": [
{
"$ref": "#/definitions/defs_channel"
},
{
"type": "null"
}
]
},
"conversation_host_id": {
"$ref": "#/definitions/defs_workspace_id"
},
"unread_count_display": {
"type": "integer"
},
"is_pending_ext_shared": {
"type": "boolean"
},
"pending_connected_team_ids": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"uniqueItems": true
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "Conversation MPIM Object",
"required": [
"id",
"name",
"created",
"creator",
"is_archived",
"is_channel",
"is_general",
"is_mpim",
"is_group",
"is_org_shared",
"is_im",
"is_shared",
"is_private",
"name_normalized",
"topic",
"purpose"
],
"properties": {
"id": {
"$ref": "#/definitions/defs_channel"
},
"name": {
"type": "string"
},
"user": {
"$ref": "#/definitions/defs_user_id"
},
"is_im": {
"type": "boolean"
},
"topic": {
"type": "object",
"required": [
"value",
"creator",
"last_set"
],
"properties": {
"value": {
"type": "string"
},
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
}
},
"additionalProperties": false
},
"latest": {
"items": [
{
"$ref": "#/definitions/objs_message"
},
{
"type": "null"
}
]
},
"shares": {
"type": "array",
"items": {
"type": "object",
"required": [
"team",
"user",
"is_active"
],
"properties": {
"team": {
"$ref": "#/definitions/objs_team"
},
"user": {
"$ref": "#/definitions/defs_user_id"
},
"is_active": {
"type": "boolean"
},
"accepted_user": {
"$ref": "#/definitions/defs_user_id"
}
},
"additionalProperties": false
},
"minItems": 0,
"uniqueItems": true
},
"created": {
"type": "integer"
},
"creator": {
"$ref": "#/definitions/defs_user_id"
},
"is_mpim": {
"enum": [
true
],
"type": "boolean"
},
"is_open": {
"type": "boolean"
},
"members": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_user_id"
},
"minItems": 0,
"uniqueItems": true
},
"purpose": {
"type": "object",
"required": [
"value",
"creator",
"last_set"
],
"properties": {
"value": {
"type": "string"
},
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
}
},
"additionalProperties": false
},
"version": {
"type": "integer"
},
"is_group": {
"type": "boolean"
},
"is_moved": {
"type": "integer"
},
"priority": {
"type": "number"
},
"unlinked": {
"type": "integer",
"title": "Field to determine whether a channel has ever been shared/disconnected in the past"
},
"is_frozen": {
"type": "boolean"
},
"is_member": {
"type": "boolean"
},
"is_shared": {
"type": "boolean"
},
"last_read": {
"$ref": "#/definitions/defs_ts"
},
"pin_count": {
"type": "integer"
},
"is_channel": {
"type": "boolean"
},
"is_general": {
"type": "boolean"
},
"is_private": {
"type": "boolean"
},
"is_starred": {
"type": "boolean"
},
"is_archived": {
"type": "boolean"
},
"num_members": {
"type": "integer"
},
"is_read_only": {
"type": "boolean"
},
"unread_count": {
"type": "integer"
},
"accepted_user": {
"$ref": "#/definitions/defs_user_id"
},
"is_ext_shared": {
"type": "boolean"
},
"is_org_shared": {
"type": "boolean"
},
"display_counts": {
"type": "object",
"required": [
"display_counts",
"guest_counts"
],
"properties": {
"guest_counts": {
"type": "integer"
},
"display_counts": {
"type": "integer"
}
},
"additionalProperties": false
},
"is_thread_only": {
"type": "boolean"
},
"pending_shared": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"previous_names": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_channel_name"
},
"minItems": 0,
"uniqueItems": true
},
"timezone_count": {
"type": "integer"
},
"name_normalized": {
"type": "string"
},
"shared_team_ids": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"internal_team_ids": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"is_non_threadable": {
"type": "boolean"
},
"connected_team_ids": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"parent_conversation": {
"items": [
{
"$ref": "#/definitions/defs_channel"
},
{
"type": "null"
}
]
},
"conversation_host_id": {
"$ref": "#/definitions/defs_workspace_id"
},
"unread_count_display": {
"type": "integer"
},
"is_pending_ext_shared": {
"type": "boolean"
},
"pending_connected_team_ids": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"uniqueItems": true
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "Conversation IM Channel Object from conversations.* methods",
"required": [
"id",
"created",
"is_im",
"is_org_shared",
"user",
"priority"
],
"properties": {
"id": {
"$ref": "#/definitions/defs_dm_id"
},
"user": {
"$ref": "#/definitions/defs_user_id"
},
"is_im": {
"type": "boolean"
},
"latest": {
"items": [
{
"$ref": "#/definitions/objs_message"
},
{
"type": "null"
}
]
},
"shares": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"team",
"date_create",
"is_active"
],
"properties": {
"id": {
"$ref": "#/definitions/defs_team"
},
"name": {
"type": "string"
},
"team": {
"$ref": "#/definitions/objs_team"
},
"is_active": {
"type": "boolean"
},
"date_create": {
"type": "integer"
}
},
"additionalProperties": false
},
"minItems": 0,
"uniqueItems": true
},
"created": {
"type": "integer"
},
"is_open": {
"type": "boolean"
},
"version": {
"type": "integer"
},
"has_pins": {
"type": "boolean"
},
"priority": {
"type": "number"
},
"is_frozen": {
"type": "boolean"
},
"is_shared": {
"type": "boolean"
},
"last_read": {
"$ref": "#/definitions/defs_ts"
},
"pin_count": {
"type": "integer"
},
"is_starred": {
"type": "boolean"
},
"is_archived": {
"type": "boolean"
},
"unread_count": {
"type": "integer"
},
"is_ext_shared": {
"type": "boolean"
},
"is_org_shared": {
"type": "boolean"
},
"is_user_deleted": {
"type": "boolean"
},
"parent_conversation": {
"items": [
{
"$ref": "#/definitions/defs_channel"
},
{
"type": "null"
}
]
},
"unread_count_display": {
"type": "integer"
}
},
"additionalProperties": false
}
]
}
objs_enterprise_user
{
"type": "object",
"required": [
"id",
"enterprise_id",
"enterprise_name",
"is_admin",
"is_owner",
"teams"
],
"properties": {
"id": {
"$ref": "#/definitions/defs_enterprise_user_id"
},
"teams": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_team"
},
"uniqueItems": true
},
"is_admin": {
"type": "boolean"
},
"is_owner": {
"type": "boolean"
},
"enterprise_id": {
"$ref": "#/definitions/defs_enterprise_id"
},
"enterprise_name": {
"$ref": "#/definitions/defs_enterprise_name"
}
},
"additionalProperties": false
}
objs_external_org_migrations
{
"type": "object",
"title": "External Org Migrations",
"required": [
"date_updated",
"current"
],
"properties": {
"current": {
"type": "array",
"items": {
"type": "object",
"required": [
"team_id",
"date_started"
],
"properties": {
"team_id": {
"type": "string"
},
"date_started": {
"type": "integer"
}
}
}
},
"date_updated": {
"type": "integer"
}
}
}
objs_file
{
"type": "object",
"title": "file object",
"properties": {
"id": {
"$ref": "#/definitions/defs_file_id"
},
"ims": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_dm_id"
},
"uniqueItems": true
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"type": "integer"
},
"user": {
"type": "string"
},
"state": {
"type": "string"
},
"title": {
"type": "string"
},
"editor": {
"$ref": "#/definitions/defs_user_id"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_group_id"
},
"uniqueItems": true
},
"shares": {
"type": "object",
"properties": {
"public": {
"additionalProperties": false
},
"private": {
"additionalProperties": false
}
},
"additionalProperties": false
},
"created": {
"type": "integer"
},
"preview": {
"type": "string"
},
"updated": {
"type": "integer"
},
"channels": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_channel_id"
},
"uniqueItems": true
},
"editable": {
"type": "boolean"
},
"filetype": {
"type": "string"
},
"mimetype": {
"type": "string"
},
"thumb_64": {
"type": "string",
"format": "uri"
},
"thumb_80": {
"type": "string",
"format": "uri"
},
"username": {
"type": "string"
},
"is_public": {
"type": "boolean"
},
"num_stars": {
"type": "integer"
},
"permalink": {
"type": "string",
"format": "uri"
},
"pinned_to": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_channel"
}
},
"reactions": {
"type": "array",
"items": {
"$ref": "#/definitions/objs_reaction"
}
},
"thumb_160": {
"type": "string",
"format": "uri"
},
"thumb_360": {
"type": "string",
"format": "uri"
},
"thumb_480": {
"type": "string",
"format": "uri"
},
"thumb_720": {
"type": "string",
"format": "uri"
},
"thumb_800": {
"type": "string",
"format": "uri"
},
"thumb_960": {
"type": "string",
"format": "uri"
},
"timestamp": {
"type": "integer"
},
"user_team": {
"$ref": "#/definitions/defs_team"
},
"is_starred": {
"type": "boolean"
},
"original_h": {
"type": "integer"
},
"original_w": {
"type": "integer"
},
"thumb_1024": {
"type": "string",
"format": "uri"
},
"thumb_tiny": {
"type": "string"
},
"date_delete": {
"type": "integer"
},
"external_id": {
"type": "string"
},
"is_external": {
"type": "boolean"
},
"last_editor": {
"$ref": "#/definitions/defs_user_id"
},
"pinned_info": {
"$ref": "#/definitions/defs_pinned_info"
},
"pretty_type": {
"type": "string"
},
"source_team": {
"$ref": "#/definitions/defs_team"
},
"thumb_360_h": {
"type": "integer"
},
"thumb_360_w": {
"type": "integer"
},
"thumb_480_h": {
"type": "integer"
},
"thumb_480_w": {
"type": "integer"
},
"thumb_720_h": {
"type": "integer"
},
"thumb_720_w": {
"type": "integer"
},
"thumb_800_h": {
"type": "integer"
},
"thumb_800_w": {
"type": "integer"
},
"thumb_960_h": {
"type": "integer"
},
"thumb_960_w": {
"type": "integer"
},
"url_private": {
"type": "string",
"format": "uri"
},
"external_url": {
"type": "string",
"format": "uri"
},
"thumb_1024_h": {
"type": "integer"
},
"thumb_1024_w": {
"type": "integer"
},
"external_type": {
"type": "string"
},
"is_tombstoned": {
"type": "boolean"
},
"comments_count": {
"type": "integer"
},
"display_as_bot": {
"type": "boolean"
},
"has_rich_preview": {
"type": "boolean"
},
"permalink_public": {
"type": "string",
"format": "uri"
},
"public_url_shared": {
"type": "boolean"
},
"non_owner_editable": {
"type": "boolean"
},
"image_exif_rotation": {
"type": "integer"
},
"url_private_download": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
objs_icon
{
"type": "object",
"properties": {
"image_34": {
"type": "string"
},
"image_44": {
"type": "string"
},
"image_68": {
"type": "string"
},
"image_88": {
"type": "string"
},
"image_102": {
"type": "string"
},
"image_132": {
"type": "string"
},
"image_230": {
"type": "string"
},
"image_default": {
"type": "boolean"
}
}
}
objs_message
{
"type": "object",
"title": "Message object",
"required": [
"text",
"type",
"ts"
],
"properties": {
"ts": {
"$ref": "#/definitions/defs_ts"
},
"file": {
"$ref": "#/definitions/objs_file"
},
"name": {
"type": "string"
},
"team": {
"$ref": "#/definitions/defs_workspace_id"
},
"text": {
"type": "string"
},
"type": {
"type": "string"
},
"user": {
"$ref": "#/definitions/defs_user_id"
},
"files": {
"type": "array",
"items": {
"$ref": "#/definitions/objs_file"
},
"minItems": 1,
"uniqueItems": true
},
"icons": {
"type": "object",
"properties": {
"emoji": {
"type": "string"
},
"image_64": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
"topic": {
"type": "string"
},
"blocks": {
"$ref": "#/definitions/blocks"
},
"bot_id": {
"items": [
{
"$ref": "#/definitions/defs_bot_id"
},
{
"type": "null",
"title": "Nil bot_id set when display_as_bot is false"
}
]
},
"upload": {
"type": "boolean"
},
"comment": {
"$ref": "#/definitions/objs_comment"
},
"inviter": {
"$ref": "#/definitions/defs_user_id"
},
"purpose": {
"type": "string"
},
"subtype": {
"type": "string"
},
"is_intro": {
"type": "boolean"
},
"old_name": {
"type": "string"
},
"username": {
"type": "string"
},
"last_read": {
"$ref": "#/definitions/defs_ts"
},
"permalink": {
"type": "string",
"format": "uri"
},
"pinned_to": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_channel"
}
},
"reactions": {
"type": "array",
"items": {
"$ref": "#/definitions/objs_reaction"
}
},
"thread_ts": {
"$ref": "#/definitions/defs_ts"
},
"user_team": {
"$ref": "#/definitions/defs_workspace_id"
},
"is_starred": {
"type": "boolean"
},
"subscribed": {
"type": "boolean"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
},
"fallback": {
"type": "string"
},
"image_url": {
"type": "string"
},
"image_bytes": {
"type": "integer"
},
"image_width": {
"type": "integer"
},
"image_height": {
"type": "integer"
}
},
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"bot_profile": {
"$ref": "#/definitions/objs_bot_profile"
},
"reply_count": {
"type": "integer"
},
"reply_users": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_user_id"
},
"minItems": 1,
"uniqueItems": true
},
"source_team": {
"$ref": "#/definitions/defs_workspace_id"
},
"latest_reply": {
"$ref": "#/definitions/defs_ts"
},
"unread_count": {
"type": "integer"
},
"user_profile": {
"$ref": "#/definitions/objs_user_profile_short"
},
"client_msg_id": {
"type": "string"
},
"display_as_bot": {
"type": "boolean"
},
"parent_user_id": {
"$ref": "#/definitions/defs_user_id"
},
"reply_users_count": {
"type": "integer"
},
"is_delayed_message": {
"type": "boolean"
}
},
"additionalProperties": false
}
objs_paging
{
"type": "object",
"title": "paging object",
"required": [
"page",
"total"
],
"properties": {
"page": {
"type": "integer"
},
"count": {
"type": "integer"
},
"pages": {
"type": "integer"
},
"spill": {
"type": "integer"
},
"total": {
"type": "integer"
},
"per_page": {
"type": "integer"
}
},
"additionalProperties": false
}
objs_primary_owner
{
"type": "object",
"required": [
"id",
"email"
],
"properties": {
"id": {
"type": "string"
},
"email": {
"type": "string"
}
}
}
objs_reaction
{
"type": "object",
"title": "Reaction object",
"required": [
"name",
"users",
"count"
],
"properties": {
"name": {
"type": "string"
},
"count": {
"type": "integer"
},
"users": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_user_id"
}
}
},
"additionalProperties": true
}
objs_reminder
{
"type": "object",
"required": [
"id",
"creator",
"user",
"text",
"recurring"
],
"properties": {
"id": {
"$ref": "#/definitions/defs_reminder_id"
},
"text": {
"type": "string"
},
"time": {
"type": "integer"
},
"user": {
"$ref": "#/definitions/defs_user_id"
},
"creator": {
"$ref": "#/definitions/defs_user_id"
},
"recurring": {
"type": "boolean"
},
"complete_ts": {
"type": "integer"
}
},
"additionalProperties": false
}
objs_resources
{
"type": "object",
"title": "resources in info from apps.permissions.info",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"items": [
{
"$ref": "#/definitions/defs_channel"
},
{
"$ref": "#/definitions/defs_team"
}
]
}
},
"wildcard": {
"type": "boolean"
},
"excluded_ids": {
"type": "array",
"items": {
"items": [
{
"$ref": "#/definitions/defs_channel"
},
{
"$ref": "#/definitions/defs_team"
}
]
}
}
},
"additionalProperties": false
}
objs_response_metadata
{
"items": [
{
"type": "object",
"title": "new paging style",
"required": [
"next_cursor"
],
"properties": {
"next_cursor": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "deprecation_warning",
"required": [
"messages",
"warnings"
],
"properties": {
"messages": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"enum": [
"method_deprecated"
],
"type": "string"
}
}
},
"additionalProperties": false
},
{
"type": "object",
"title": "deprecation_warning and paging style together",
"required": [
"messages",
"warnings",
"next_cursor"
],
"properties": {
"messages": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"enum": [
"method_deprecated"
],
"type": "string"
}
},
"next_cursor": {
"type": "string"
}
},
"additionalProperties": false
}
]
}
objs_scopes
{
"type": "array",
"items": {
"type": "string",
"title": "Named OAuth scopes",
"x-examples": [
"chat:write",
"im:history",
"im:read"
]
}
}
objs_subteam
{
"type": "object",
"title": "Subteam/Usergroup Object",
"required": [
"id",
"team_id",
"is_usergroup",
"is_subteam",
"name",
"description",
"handle",
"is_external",
"date_create",
"date_update",
"date_delete",
"auto_type",
"auto_provision",
"enterprise_subteam_id",
"created_by",
"updated_by",
"deleted_by",
"prefs"
],
"properties": {
"id": {
"$ref": "#/definitions/defs_subteam_id"
},
"name": {
"type": "string"
},
"prefs": {
"type": "object",
"required": [
"channels",
"groups"
],
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_group_id"
}
},
"channels": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_channel_id"
}
}
},
"additionalProperties": false
},
"users": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_user_id"
}
},
"handle": {
"type": "string"
},
"team_id": {
"$ref": "#/definitions/defs_team"
},
"auto_type": {
"items": [
{
"type": "null"
},
{
"enum": [
"owner",
"admin"
],
"type": "string"
}
]
},
"created_by": {
"$ref": "#/definitions/defs_user_id"
},
"deleted_by": {
"items": [
{
"type": "null"
},
{
"$ref": "#/definitions/defs_user_id"
}
]
},
"is_subteam": {
"type": "boolean"
},
"updated_by": {
"$ref": "#/definitions/defs_user_id"
},
"user_count": {
"type": "integer"
},
"date_create": {
"type": "integer"
},
"date_delete": {
"type": "integer"
},
"date_update": {
"type": "integer"
},
"description": {
"type": "string"
},
"is_external": {
"type": "boolean"
},
"is_usergroup": {
"type": "boolean"
},
"channel_count": {
"type": "integer"
},
"auto_provision": {
"type": "boolean"
},
"enterprise_subteam_id": {
"type": "string"
}
},
"additionalProperties": false
}
objs_team
{
"type": "object",
"title": "Team Object",
"required": [
"id",
"name",
"domain",
"email_domain",
"icon"
],
"properties": {
"id": {
"$ref": "#/definitions/defs_workspace_id"
},
"icon": {
"$ref": "#/definitions/objs_icon"
},
"name": {
"type": "string"
},
"plan": {
"enum": [
"",
"std",
"plus",
"compliance",
"enterprise"
],
"type": "string"
},
"domain": {
"type": "string"
},
"locale": {
"type": "string"
},
"created": {
"type": "integer"
},
"deleted": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"limit_ts": {
"type": "integer"
},
"date_create": {
"type": "integer"
},
"description": {
"type": [
"null",
"string"
]
},
"is_assigned": {
"type": "boolean"
},
"discoverable": {
"items": [
{
"type": "null"
},
{
"type": "string"
}
]
},
"email_domain": {
"type": "string"
},
"pay_prod_cur": {
"type": "string"
},
"sso_provider": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"label": {
"type": "string"
}
}
},
"enterprise_id": {
"$ref": "#/definitions/defs_enterprise_id"
},
"is_enterprise": {
"type": "integer"
},
"primary_owner": {
"$ref": "#/definitions/objs_primary_owner"
},
"messages_count": {
"type": "integer"
},
"avatar_base_url": {
"type": "string",
"format": "uri"
},
"enterprise_name": {
"$ref": "#/definitions/defs_enterprise_name"
},
"over_storage_limit": {
"type": "boolean"
},
"msg_edit_window_mins": {
"type": "integer"
},
"has_compliance_export": {
"type": "boolean"
},
"is_over_storage_limit": {
"type": "boolean"
},
"external_org_migrations": {
"$ref": "#/definitions/objs_external_org_migrations"
},
"over_integrations_limit": {
"type": "boolean"
}
},
"additionalProperties": false
}
objs_team_profile_field
{
"type": "object",
"required": [
"id",
"ordering",
"label",
"hint",
"type"
],
"properties": {
"id": {
"type": "string",
"pattern": "^X[a-zA-Z0-9]{9,}$"
},
"hint": {
"type": "string"
},
"type": {
"enum": [
"text",
"date",
"link",
"mailto",
"options_list",
"user"
],
"type": "string"
},
"label": {
"type": "string"
},
"options": {
"items": [
{
"type": "null"
},
{
"$ref": "#/definitions/objs_team_profile_field_option"
}
]
},
"ordering": {
"type": "number"
},
"is_hidden": {
"type": "boolean"
},
"field_name": {
"type": [
"null",
"string"
]
},
"possible_values": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
objs_team_profile_field_option
{
"type": "object",
"properties": {
"is_scim": {
"type": [
"null",
"boolean"
]
},
"is_custom": {
"type": [
"null",
"boolean"
]
},
"is_protected": {
"type": [
"null",
"boolean"
]
},
"is_multiple_entry": {
"type": [
"null",
"boolean"
]
}
},
"additionalProperties": false
}
objs_user
{
"items": [
{
"type": "object",
"required": [
"id",
"name",
"profile",
"is_bot",
"updated",
"is_app_user"
],
"properties": {
"id": {
"$ref": "#/definitions/defs_user_id"
},
"tz": {
"items": [
{
"type": "null"
},
{
"type": "string"
}
]
},
"name": {
"type": "string"
},
"team": {
"$ref": "#/definitions/defs_workspace_id"
},
"color": {
"type": "string",
"pattern": "^[a-fA-F0-9]{6}$"
},
"is_bot": {
"type": "boolean"
},
"locale": {
"type": "string"
},
"deleted": {
"type": "boolean"
},
"has_2fa": {
"type": "boolean"
},
"profile": {
"$ref": "#/definitions/objs_user_profile"
},
"team_id": {
"$ref": "#/definitions/defs_workspace_id"
},
"updated": {
"type": "number"
},
"is_admin": {
"type": "boolean"
},
"is_owner": {
"type": "boolean"
},
"presence": {
"type": "string"
},
"tz_label": {
"type": "string"
},
"real_name": {
"type": "string"
},
"tz_offset": {
"type": "number"
},
"is_app_user": {
"type": "boolean"
},
"is_external": {
"type": "boolean"
},
"is_stranger": {
"type": "boolean"
},
"is_forgotten": {
"type": "boolean"
},
"team_profile": {
"type": "object",
"required": [
"fields"
],
"properties": {
"fields": {
"type": "array",
"items": {
"$ref": "#/definitions/objs_team_profile_field"
},
"minItems": 1,
"uniqueItems": true
}
},
"additionalProperties": false
},
"is_restricted": {
"type": "boolean"
},
"enterprise_user": {
"$ref": "#/definitions/objs_enterprise_user"
},
"is_invited_user": {
"type": "boolean"
},
"two_factor_type": {
"type": "string"
},
"is_primary_owner": {
"type": "boolean"
},
"is_ultra_restricted": {
"type": "boolean"
}
},
"description": "user object for non enterprise type",
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"name",
"profile",
"is_bot",
"updated",
"is_app_user"
],
"properties": {
"id": {
"$ref": "#/definitions/defs_user_id"
},
"tz": {
"items": [
{
"type": "null"
},
{
"type": "string"
}
]
},
"name": {
"type": "string"
},
"color": {
"type": "string",
"pattern": "^([a-fA-F0-9]{6})?$",
"description": "refercing to bug: https://jira.tinyspeck.com/browse/EVALUE-1559"
},
"teams": {
"type": "array",
"items": {
"$ref": "#/definitions/defs_workspace_id"
},
"minItems": 1,
"uniqueItems": true
},
"is_bot": {
"type": "boolean"
},
"locale": {
"type": "string"
},
"deleted": {
"type": "boolean"
},
"has_2fa": {
"type": "boolean"
},
"profile": {
"$ref": "#/definitions/objs_user_profile"
},
"team_id": {
"$ref": "#/definitions/defs_workspace_id"
},
"updated": {
"type": "number"
},
"is_admin": {
"type": "boolean"
},
"is_owner": {
"type": "boolean"
},
"presence": {
"type": "string"
},
"tz_label": {
"type": "string"
},
"real_name": {
"type": "string"
},
"tz_offset": {
"type": "number"
},
"is_app_user": {
"type": "boolean"
},
"is_external": {
"type": "boolean"
},
"is_stranger": {
"type": "boolean"
},
"is_forgotten": {
"type": "boolean"
},
"team_profile": {
"type": "object",
"required": [
"fields"
],
"properties": {
"fields": {
"type": "array",
"items": {
"$ref": "#/definitions/objs_team_profile_field"
},
"minItems": 1,
"uniqueItems": true
}
},
"additionalProperties": false
},
"is_restricted": {
"type": "boolean"
},
"enterprise_user": {
"$ref": "#/definitions/objs_enterprise_user"
},
"two_factor_type": {
"type": "string"
},
"is_primary_owner": {
"type": "boolean"
},
"is_ultra_restricted": {
"type": "boolean"
}
},
"description": "enterprise user",
"additionalProperties": false
}
]
}
objs_user_profile
{
"type": "object",
"title": "User profile object",
"required": [
"real_name",
"display_name",
"avatar_hash",
"real_name_normalized",
"display_name_normalized",
"title",
"phone",
"skype",
"status_text",
"status_emoji",
"fields"
],
"properties": {
"name": {
"type": [
"null",
"string"
]
},
"team": {
"$ref": "#/definitions/defs_workspace_id"
},
"email": {
"type": [
"null",
"string"
],
"format": "email"
},
"phone": {
"type": "string"
},
"skype": {
"type": "string"
},
"title": {
"type": "string"
},
"bot_id": {
"$ref": "#/definitions/defs_bot_id"
},
"fields": {
"type": [
"object",
"null",
"array"
],
"items": {
"type": "object"
}
},
"updated": {
"type": "integer"
},
"user_id": {
"type": "string"
},
"image_24": {
"type": [
"null",
"string"
],
"format": "uri"
},
"image_32": {
"type": [
"null",
"string"
],
"format": "uri"
},
"image_48": {
"type": [
"null",
"string"
],
"format": "uri"
},
"image_72": {
"type": [
"null",
"string"
],
"format": "uri"
},
"pronouns": {
"type": "string"
},
"username": {
"type": [
"null",
"string"
]
},
"image_192": {
"type": [
"null",
"string"
],
"format": "uri"
},
"image_512": {
"type": [
"null",
"string"
],
"format": "uri"
},
"last_name": {
"type": [
"null",
"string"
]
},
"real_name": {
"type": "string"
},
"api_app_id": {
"$ref": "#/definitions/defs_optional_app_id"
},
"first_name": {
"type": [
"null",
"string"
]
},
"image_1024": {
"type": [
"null",
"string"
],
"format": "uri"
},
"avatar_hash": {
"type": "string"
},
"is_app_user": {
"type": "boolean"
},
"status_text": {
"type": "string"
},
"display_name": {
"type": "string"
},
"status_emoji": {
"type": "string"
},
"always_active": {
"type": "boolean"
},
"is_restricted": {
"type": [
"null",
"boolean"
]
},
"image_original": {
"type": [
"null",
"string"
],
"format": "uri"
},
"is_custom_image": {
"type": "boolean"
},
"guest_invited_by": {
"type": [
"null",
"string"
]
},
"memberships_count": {
"type": "integer"
},
"status_expiration": {
"type": "integer"
},
"guest_expiration_ts": {
"type": [
"null",
"integer"
]
},
"is_ultra_restricted": {
"type": [
"null",
"boolean"
]
},
"status_default_text": {
"type": "string"
},
"real_name_normalized": {
"type": "string"
},
"status_default_emoji": {
"type": "string"
},
"status_text_canonical": {
"type": [
"null",
"string"
]
},
"last_avatar_image_hash": {
"type": "string"
},
"display_name_normalized": {
"type": "string"
},
"status_default_text_canonical": {
"type": [
"null",
"string"
]
}
},
"additionalProperties": false
}
objs_user_profile_short
{
"type": "object",
"required": [
"avatar_hash",
"image_72",
"first_name",
"real_name",
"display_name",
"team",
"name",
"is_restricted",
"is_ultra_restricted"
],
"properties": {
"name": {
"type": "string"
},
"team": {
"$ref": "#/definitions/defs_workspace_id"
},
"image_72": {
"type": "string",
"format": "uri"
},
"real_name": {
"type": "string"
},
"first_name": {
"type": [
"string",
"null"
]
},
"avatar_hash": {
"type": "string"
},
"display_name": {
"type": "string"
},
"is_restricted": {
"type": "boolean"
},
"is_ultra_restricted": {
"type": "boolean"
},
"real_name_normalized": {
"type": "string"
},
"display_name_normalized": {
"type": "string"
}
},
"additionalProperties": false
}