openapi-directory/api/slack.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://slack.com/api"}],"info":{"contact":{"name":"Slack developer relations","url":"https://api.slack.com/support"},"description":"One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens blessed with related OAuth scopes.","title":"Slack Web API","version":"1.7.0","x-apisguru-categories":["collaboration","messaging"],"x-logo":{"url":"http://static.tumblr.com/wvuzcz9/LlKncfhmp/slack_logo_240.png"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/slackapi/slack-api-specs/master/web-api/slack_web_openapi_v2.json","version":"3.0"}],"x-providerName":"slack.com"},"externalDocs":{"description":"Learn more about the Slack Web API","url":"https://api.slack.com/web"},"tags":[],"paths":{"/admin.apps.approve":{"post":{"description":"Approve an app for installation on a workspace.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.apps.approve"},"operationId":"admin_apps_approve","parameters":[{"description":"Authentication token. Requires scope: `admin.apps:write`","in":"header","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"app_id":{"description":"The id of the app to approve.","type":"string"},"request_id":{"description":"The id of the request to approve.","type":"string"},"team_id":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"Default success template","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok"],"title":"Default error template","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.apps:write"]}],"tags":["admin.apps","admin"]}},"/admin.apps.approved.list":{"get":{"description":"List approved apps for an org or workspace.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.apps.approved.list"},"operationId":"admin_apps_approved_list","parameters":[{"description":"Authentication token. Requires scope: `admin.apps:read`","in":"query","name":"token","required":true,"schema":{"type":"string"}},{"description":"The maximum number of items to return. Must be between 1 - 1000 both inclusive.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"Set `cursor` to `next_cursor` returned by the previous call to list items in the next page","in":"query","name":"cursor","schema":{"type":"string"}},{"in":"query","name":"team_id","schema":{"type":"string"}},{"in":"query","name":"enterprise_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"approved_apps":[{"app":{"additional_info":"","app_directory_url":"https://myteam.enterprise.slack.com/apps/A0W7UKG8E-my-test-app","app_homepage_url":"https://www.slack.com","description":"test app","help_url":"https://www.slack.com","icons":{"image_1024":"https://3026743124446w96_2bd4ea1ad1f89a23c242_1024.png","image_128":"https://30267341249446w6_2bd4ea1ad1f89a23c242_128.png","image_192":"https://30267431249446w6_2bd4ea1ad1f89a23c242_192.png","image_32":"https://302674312496446w_2bd4ea1ad1f89a23c242_32.png","image_36":"https://302674312496446w_2bd4ea1ad1f89a23c242_36.png","image_48":"https://302674312496446w_2bd4ea1ad1f89a23c242_48.png","image_512":"https://30267431249446w6_2bd4ea1ad1f89a23c242_512.png","image_64":"https://302674312496446w_2bd4ea1ad1f89a23c242_64.png","image_72":"https://302674312496446w_2bd4ea1ad1f89a23c242_72.png","image_96":"https://302674312496446w_2bd4ea1ad1f89a23c242_96.png","image_original":"https://302674446w12496_2bd4ea1ad1f89a23c242_original.png"},"id":"A0W7UKG8E","is_app_directory_approved":false,"is_internal":false,"name":"My Test App","privacy_policy_url":"https://www.slack.com"},"date_updated":1574296707,"last_resolved_by":{"actor_id":"W0G82F4FD","actor_type":"user"},"scopes":[{"description":"Add the ability for people to direct message or mention @my_test_app","is_sensitive":true,"name":"bot","token_type":"bot"}]}],"ok":true,"response_metadata":{"next_cursor":""}}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"Default success template","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok"],"title":"Default error template","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.apps:read"]}],"tags":["admin.apps.approved","admin"]}},"/admin.apps.requests.list":{"get":{"description":"List app requests for a team/workspace.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.apps.requests.list"},"operationId":"admin_apps_requests_list","parameters":[{"description":"Authentication token. Requires scope: `admin.apps:read`","in":"query","name":"token","required":true,"schema":{"type":"string"}},{"description":"The maximum number of items to return. Must be between 1 - 1000 both inclusive.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"Set `cursor` to `next_cursor` returned by the previous call to list items in the next page","in":"query","name":"cursor","schema":{"type":"string"}},{"in":"query","name":"team_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"app_requests":[{"app":{"additional_info":"","app_directory_url":"https://acmecorp.slack.com/apps/A061BL8RQ0-test-app","app_homepage_url":"","description":"","help_url":"","icons":{"image_1024":"/cdn/15258203/img/testapp/service_1024.png","image_128":"/cdn/157258203/img/testapp/service_128.png","image_192":"/cdn/157258203/img/testapp/service_192.png","image_32":"/cdn/157658203/img/testapp/service_32.png","image_36":"/cdn/157658203/img/testapp/service_36.png","image_48":"/cdn/157658203/img/testapp/service_48.png","image_512":"/cdn/15758203/img/testapp/service_512.png","image_64":"/cdn/157658203/img/testapp/service_64.png","image_72":"/cdn/157658203/img/testapp/service_72.png","image_96":"/cdn/157658203/img/testapp/service_96.png"},"id":"A061BL8RQ0","is_app_directory_approved":true,"is_internal":false,"name":"Test App","privacy_policy_url":"https://testapp.com/privacy"},"date_created":1578956327,"id":"Ar0XJGFLMLS","message":"test test again","previous_resolution":null,"scopes":[{"description":"Post messages to specific channels in Slack","is_sensitive":false,"name":"incoming-webhook","token_type":"user"}],"team":{"domain":"acmecorp","id":"T0M94LNUCR","name":"Acme Corp"},"user":{"email":"janedoe@example.com","id":"W08RA9G5HR","name":"Jane Doe"}}],"ok":true,"response_metadata":{"next_cursor":""}}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"Default success template","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"missing_scope","needed":"admin.apps:read","ok":false,"provided":"read,client,admin,identify,post,apps"}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok"],"title":"Default error template","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.apps:read"]}],"tags":["admin.apps.requests","admin"]}},"/admin.apps.restrict":{"post":{"description":"Restrict an app for installation on a workspace.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.apps.restrict"},"operationId":"admin_apps_restrict","parameters":[{"description":"Authentication token. Requires scope: `admin.apps:write`","in":"header","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"app_id":{"description":"The id of the app to restrict.","type":"string"},"request_id":{"description":"The id of the request to restrict.","type":"string"},"team_id":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"Default success template","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok"],"title":"Default error template","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.apps:write"]}],"tags":["admin.apps","admin"]}},"/admin.apps.restricted.list":{"get":{"description":"List restricted apps for an org or workspace.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.apps.restricted.list"},"operationId":"admin_apps_restricted_list","parameters":[{"description":"Authentication token. Requires scope: `admin.apps:read`","in":"query","name":"token","required":true,"schema":{"type":"string"}},{"description":"The maximum number of items to return. Must be between 1 - 1000 both inclusive.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"Set `cursor` to `next_cursor` returned by the previous call to list items in the next page","in":"query","name":"cursor","schema":{"type":"string"}},{"in":"query","name":"team_id","schema":{"type":"string"}},{"in":"query","name":"enterprise_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true,"response_metadata":{"next_cursor":""},"restricted_apps":[{"app":{"additional_info":"","app_directory_url":"https://myteam.enterprise.slack.com/apps/A0FDLP8M2L-my-test-app","app_homepage_url":"https://example.com","description":"A fun test app for Slack","help_url":"https://example.com","icons":{"image_1024":"https://1433265338rl878408_eb57dbc818daa4ba15d6_1024.png","image_128":"https://4332653438rl87808_eb57dbc818daa4ba15d6_128.png","image_192":"https://4332653438rl87808_eb57dbc818daa4ba15d6_192.png","image_32":"https://143326534038rl8788_eb57dbc818daa4ba15d6_32.png","image_36":"https://143326534038rl8788_eb57dbc818daa4ba15d6_36.png","image_48":"https://143326534038rl8788_eb57dbc818daa4ba15d6_48.png","image_512":"https://4332653438rl87808_eb57dbc818daa4ba15d6_512.png","image_64":"https://143326534038rl8788_eb57dbc818daa4ba15d6_64.png","image_72":"https://143326534038rl8788_eb57dbc818daa4ba15d6_72.png","image_96":"https://143326534038rl8788_eb57dbc818daa4ba15d6_96.png","image_original":"https://143338rl8782653408_eb57dbc818daa4ba15d6_original.png"},"id":"A0FDLP8M2L","is_app_directory_approved":true,"is_internal":false,"name":"My Test App","privacy_policy_url":"https://example.com"},"date_updated":1574296721,"last_resolved_by":{"actor_id":"W0G82LMFD","actor_type":"user"},"scopes":[{"description":"Upload, edit, and delete files on the user‟s behalf","is_sensitive":true,"name":"files:write:user","token_type":"user"}]}]}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"Default success template","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok"],"title":"Default error template","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.apps:read"]}],"tags":["admin.apps.restricted","admin"]}},"/admin.conversations.archive":{"post":{"description":"Archive a public or private channel.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.archive"},"operationId":"admin_conversations_archive","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:write`","in":"header","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"channel_id":{"description":"The channel to archive.","type":"string"}},"required":["channel_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":false,"description":"Schema for successful response of admin.conversations.archive","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"admin.conversations.archive schema","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":false,"description":"Schema for error response from admin.conversations.archive","properties":{"error":{"enum":["feature_not_enabled","channel_not_found","channel_type_not_supported","default_org_wide_channel","already_archived","cant_archive_general","restricted_action","could_not_archive_channel"],"type":"string"},"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok","error"],"title":"admin.conversations.archive error schema","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:write"]}],"tags":["admin.conversations","admin"]}},"/admin.conversations.convertToPrivate":{"post":{"description":"Convert a public channel to a private channel.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.convertToPrivate"},"operationId":"admin_conversations_convertToPrivate","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:write`","in":"header","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"channel_id":{"description":"The channel to convert to private.","type":"string"}},"required":["channel_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":false,"description":"Schema for successful response of admin.conversations.convertToPrivate","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"admin.conversations.convertToPrivate schema","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":false,"description":"Schema for error response from admin.conversations.convertToPrivate","properties":{"error":{"enum":["feature_not_enabled","restricted_action","name_taken","channel_not_found","channel_type_not_supported","default_org_wide_channel","method_not_supported_for_channel_type","could_not_convert_channel","external_channel_migrating"],"type":"string"},"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok","error"],"title":"admin.conversations.convertToPrivate error schema","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:write"]}],"tags":["admin.conversations","admin"]}},"/admin.conversations.create":{"post":{"description":"Create a public or private channel-based conversation.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.create"},"operationId":"admin_conversations_create","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:write`","in":"header","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"description":{"description":"Description of the public or private channel to create.","type":"string"},"is_private":{"description":"When `true`, creates a private channel instead of a public channel","type":"boolean"},"name":{"description":"Name of the public or private channel to create.","type":"string"},"org_wide":{"description":"When `true`, the channel will be available org-wide. Note: if the channel is not `org_wide=true`, you must specify a `team_id` for this channel","type":"boolean"},"team_id":{"description":"The workspace to create the channel in. Note: this argument is required unless you set `org_wide=true`.","type":"string"}},"required":["name","is_private"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"channel_id":"C12345","ok":true}}},"schema":{"additionalProperties":false,"description":"Schema for successful response of admin.conversations.create","properties":{"channel_id":{"$ref":"#/components/schemas/defs_channel_id"},"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"admin.conversations.create schema","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":false,"description":"Schema for error response from admin.conversations.create","properties":{"error":{"enum":["feature_not_enabled","name_taken","restricted_action","team_not_found","invalid_team","invalid_name","could_not_create_channel","team_id_or_org_required"],"type":"string"},"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok","error"],"title":"admin.conversations.create error schema","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:write"]}],"tags":["admin.conversations","admin"]}},"/admin.conversations.delete":{"post":{"description":"Delete a public or private channel.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.delete"},"operationId":"admin_conversations_delete","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:write`","in":"header","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"channel_id":{"description":"The channel to delete.","type":"string"}},"required":["channel_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":false,"description":"Schema for successful response of admin.conversations.delete","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"admin.conversations.delete schema","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":false,"description":"Schema for error response from admin.conversations.delete","properties":{"error":{"enum":["feature_not_enabled","not_an_admin","channel_not_found","channel_type_not_supported","default_org_wide_channel","restricted_action","could_not_delete_channel","missing_scope"],"type":"string"},"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok","error"],"title":"admin.conversations.delete error schema","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:write"]}],"tags":["admin.conversations","admin"]}},"/admin.conversations.disconnectShared":{"post":{"description":"Disconnect a connected channel from one or more workspaces.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.disconnectShared"},"operationId":"admin_conversations_disconnectShared","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:write`","in":"header","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"channel_id":{"description":"The channel to be disconnected from some workspaces.","type":"string"},"leaving_team_ids":{"description":"The team to be removed from the channel. Currently only a single team id can be specified.","type":"string"}},"required":["channel_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":false,"description":"Schema for successful response of admin.conversations.disconnectShared","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"admin.conversations.rename schema","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":false,"description":"Schema for error response from admin.conversations.disconnectShared","properties":{"error":{"enum":["feature_not_enabled","not_an_admin","not_an_enterprise","channel_not_found","not_supported","team_not_found","restricted_action","missing_scope","leaving_team_not_in_channel","no_teams_to_disconnect","leaving_team_required","cannot_kick_team","cannot_kick_home_team"],"type":"string"},"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok","error"],"title":"admin.conversations.disconnectShared error schema","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:write"]}],"tags":["admin.conversations","admin"]}},"/admin.conversations.ekm.listOriginalConnectedChannelInfo":{"get":{"description":"List all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo"},"operationId":"admin_conversations_ekm_listOriginalConnectedChannelInfo","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:read`","in":"query","name":"token","required":true,"schema":{"type":"string"}},{"description":"A comma-separated list of channels to filter to.","in":"query","name":"channel_ids","schema":{"type":"string"}},{"description":"A comma-separated list of the workspaces to which the channels you would like returned belong.","in":"query","name":"team_ids","schema":{"type":"string"}},{"description":"The maximum number of items to return. Must be between 1 - 1000 both inclusive.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.","in":"query","name":"cursor","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"channels":[{"id":"string","internal_team_ids":"array","original_connected_channel_id":"string","original_connected_host_id":"string"}],"ok":true}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"Default success template","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok"],"title":"Default error template","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:read"]}],"tags":["admin.conversations.ekm","admin"]}},"/admin.conversations.getConversationPrefs":{"get":{"description":"Get conversation preferences for a public or private channel.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.getConversationPrefs"},"operationId":"admin_conversations_getConversationPrefs","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:read`","in":"header","name":"token","required":true,"schema":{"type":"string"}},{"description":"The channel to get preferences for.","in":"query","name":"channel_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":false,"description":"Schema for successful response of admin.conversations.getConversationPrefs","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"},"prefs":{"properties":{"can_thread":{"properties":{"type":{"items":{"type":"string"},"type":"array"},"user":{"items":{"type":"string"},"type":"array"}},"type":"object"},"who_can_post":{"properties":{"type":{"items":{"type":"string"},"type":"array"},"user":{"items":{"type":"string"},"type":"array"}},"type":"object"}},"type":"object"}},"required":["ok"],"title":"admin.conversations.getConversationPrefs schema","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":false,"description":"Schema for error response from admin.conversations.getConversationPrefs","properties":{"error":{"enum":["feature_not_enabled","not_an_admin","not_an_enterprise","restricted_action","missing_scope","channel_not_found","channel_type_not_supported","could_not_get_conversation_prefs"],"type":"string"},"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok","error"],"title":"admin.conversations.unarchive error schema","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:read"]}],"tags":["admin.conversations","admin"]}},"/admin.conversations.getTeams":{"get":{"description":"Get all the workspaces a given public or private channel is connected to within this Enterprise org.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.getTeams"},"operationId":"admin_conversations_getTeams","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:read`","in":"header","name":"token","required":true,"schema":{"type":"string"}},{"description":"The channel to determine connected workspaces within the organization for.","in":"query","name":"channel_id","required":true,"schema":{"type":"string"}},{"description":"Set `cursor` to `next_cursor` returned by the previous call to list items in the next page","in":"query","name":"cursor","schema":{"type":"string"}},{"description":"The maximum number of items to return. Must be between 1 - 1000 both inclusive.","in":"query","name":"limit","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true,"teams":["T1234","T5678"]}}},"schema":{"additionalProperties":false,"description":"Schema for successful response of admin.conversations.getTeams","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"},"response_metadata":{"additionalProperties":false,"properties":{"next_cursor":{"type":"string"}},"required":["next_cursor"],"type":"object"},"team_ids":{"items":{"$ref":"#/components/schemas/defs_team"},"type":"array"}},"required":["ok","team_ids"],"title":"admin.conversations.getTeams schema","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":false,"description":"Schema for error response from admin.conversations.getTeams","properties":{"error":{"enum":["feature_not_enabled","channel_not_found","channel_type_not_supported","unsupported_team_type","restricted_action","could_not_get_teams","invalid_cursor","invalid_limit"],"type":"string"},"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok","error"],"title":"admin.conversations.getTeams error schema","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:read"]}],"tags":["admin.conversations","admin"]}},"/admin.conversations.invite":{"post":{"description":"Invite a user to a public or private channel.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.invite"},"operationId":"admin_conversations_invite","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:write`","in":"header","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"channel_id":{"description":"The channel that the users will be invited to.","type":"string"},"user_ids":{"description":"The users to invite.","type":"string"}},"required":["user_ids","channel_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":false,"description":"Schema for successful response of admin.conversations.invite","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"admin.conversations.invite schema","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":true,"description":"Schema for error response from admin.conversations.invite","properties":{"error":{"enum":["feature_not_enabled","channel_not_found","channel_type_not_supported","default_org_wide_channel","restricted_action","user_must_be_admin","failed_for_some_users"],"type":"string"},"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok","error"],"title":"admin.conversations.invite error schema","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:write"]}],"tags":["admin.conversations","admin"]}},"/admin.conversations.rename":{"post":{"description":"Rename a public or private channel.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.rename"},"operationId":"admin_conversations_rename","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:write`","in":"header","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"channel_id":{"description":"The channel to rename.","type":"string"},"name":{"type":"string"}},"required":["channel_id","name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":false,"description":"Schema for successful response of admin.conversations.rename","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"admin.conversations.rename schema","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":false,"description":"Schema for error response from admin.conversations.rename","properties":{"error":{"enum":["feature_not_enabled","channel_not_found","channel_type_not_supported","restricted_action","could_not_rename_channel","default_org_wide_channel","name_taken"],"type":"string"},"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok","error"],"title":"admin.conversations.unarchive error schema","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:write"]}],"tags":["admin.conversations","admin"]}},"/admin.conversations.restrictAccess.addGroup":{"post":{"description":"Add an allowlist of IDP groups for accessing a channel","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup"},"operationId":"admin_conversations_restrictAccess_addGroup","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"channel_id":{"description":"The channel to link this group to.","type":"string"},"group_id":{"description":"The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to be an allowlist for the private channel.","type":"string"},"team_id":{"description":"The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.","type":"string"},"token":{"description":"Authentication token. Requires scope: `admin.conversations:write`","type":"string"}},"required":["token","group_id","channel_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"Default success template","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok"],"title":"Default error template","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:write"]}],"tags":["admin.conversations.restrictAccess","admin"]}},"/admin.conversations.restrictAccess.listGroups":{"get":{"description":"List all IDP Groups linked to a channel","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups"},"operationId":"admin_conversations_restrictAccess_listGroups","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:read`","in":"query","name":"token","required":true,"schema":{"type":"string"}},{"in":"query","name":"channel_id","required":true,"schema":{"type":"string"}},{"description":"The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.","in":"query","name":"team_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"group_ids":["YOUR_GROUP_ID"],"ok":true}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"Default success template","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok"],"title":"Default error template","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:read"]}],"tags":["admin.conversations.restrictAccess","admin"]}},"/admin.conversations.restrictAccess.removeGroup":{"post":{"description":"Remove a linked IDP group linked from a private channel","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup"},"operationId":"admin_conversations_restrictAccess_removeGroup","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"channel_id":{"description":"The channel to remove the linked group from.","type":"string"},"group_id":{"description":"The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to remove from the private channel.","type":"string"},"team_id":{"description":"The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.","type":"string"},"token":{"description":"Authentication token. Requires scope: `admin.conversations:write`","type":"string"}},"required":["token","team_id","group_id","channel_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"Default success template","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok"],"title":"Default error template","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:write"]}],"tags":["admin.conversations.restrictAccess","admin"]}},"/admin.conversations.search":{"get":{"description":"Search for public or private channels in an Enterprise organization.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.search"},"operationId":"admin_conversations_search","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:read`","in":"header","name":"token","required":true,"schema":{"type":"string"}},{"description":"Comma separated string of team IDs, signifying the workspaces to search through.","in":"query","name":"team_ids","schema":{"type":"string"}},{"description":"Name of the the channel to query by.","in":"query","name":"query","schema":{"type":"string"}},{"description":"Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.","in":"query","name":"cursor","schema":{"type":"string"}},{"description":"The type of channel to include or exclude in the search. For example `private` will search private channels, while `private_exclude` will exclude them. For a full list of types, check the [Types section](#types).","in":"query","name":"search_channel_types","schema":{"type":"string"}},{"description":"Possible values are `relevant` (search ranking based on what we think is closest), `name` (alphabetical), `member_count` (number of users in the channel), and `created` (date channel was created). You can optionally pair this with the `sort_dir` arg to change how it is sorted ","in":"query","name":"sort","schema":{"type":"string"}},{"description":"Sort direction. Possible values are `asc` for ascending order like (1, 2, 3) or (a, b, c), and `desc` for descending order like (3, 2, 1) or (c, b, a)","in":"query","name":"sort_dir","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"channels":[{"created":1449252889,"creator":"U012A3CDE","id":"C012AB3CD","is_archived":false,"is_channel":true,"is_ext_shared":false,"is_general":true,"is_group":false,"is_im":false,"is_member":true,"is_mpim":false,"is_org_shared":false,"is_pending_ext_shared":false,"is_private":false,"is_shared":false,"name":"general","name_normalized":"general","num_members":4,"pending_shared":[],"previous_names":[],"purpose":{"creator":"","last_set":0,"value":"This channel is for team-wide communication and announcements. All team members are in this channel."},"topic":{"creator":"","last_set":0,"value":"Company-wide announcements and work-based matters"},"unlinked":0}],"ok":true,"response_metadata":{"next_cursor":"dGVhbTpDMDYxRkE1UEI="}}}},"schema":{"additionalProperties":false,"description":"Schema for successful response of admin.conversations.search","properties":{"channels":{"items":{"$ref":"#/components/schemas/objs_channel"},"type":"array"},"next_cursor":{"type":"string"}},"required":["channels","next_cursor"],"title":"admin.conversations.search schema","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"not_an_enterprise","ok":false}}},"schema":{"additionalProperties":false,"description":"Schema for error response from admin.conversations.search","properties":{"error":{"enum":["feature_not_enabled","not_an_admin","not_an_enterprise","team_not_found","not_allowed","invalid_auth","invalid_cursor","invalid_search_channel_type","invalid_sort","invalid_sort_dir"],"type":"string"},"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok","error"],"title":"admin.conversations.search error schema","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:read"]}],"tags":["admin.conversations","admin"]}},"/admin.conversations.setConversationPrefs":{"post":{"description":"Set the posting permissions for a public or private channel.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.setConversationPrefs"},"operationId":"admin_conversations_setConversationPrefs","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:write`","in":"header","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"channel_id":{"description":"The channel to set the prefs for","type":"string"},"prefs":{"description":"The prefs for this channel in a stringified JSON format.","type":"string"}},"required":["channel_id","prefs"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":false,"description":"Schema for successful response of admin.conversations.setConversationPrefs","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"admin.conversations.setConversationPrefs schema","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":false,"description":"Schema for error response from admin.conversations.setConversationPrefs","properties":{"error":{"enum":["feature_not_enabled","not_an_admin","channel_not_found","channel_type_not_supported","restricted_action","missing_scope","could_not_set_channel_pref","default_org_wide_channel"],"type":"string"},"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok","error"],"title":"admin.conversations.setConversationPrefs error schema","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:write"]}],"tags":["admin.conversations","admin"]}},"/admin.conversations.setTeams":{"post":{"description":"Set the workspaces in an Enterprise grid org that connect to a public or private channel.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.setTeams"},"operationId":"admin_conversations_setTeams","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:write`","in":"header","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"channel_id":{"description":"The encoded `channel_id` to add or remove to workspaces.","type":"string"},"org_channel":{"description":"True if channel has to be converted to an org channel","type":"boolean"},"target_team_ids":{"description":"A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.","type":"string"},"team_id":{"description":"The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.","type":"string"}},"required":["channel_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"Default success template","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","ok":false}}},"schema":{"additionalProperties":true,"description":"This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_false"}},"required":["ok"],"title":"Default error template","type":"object"}}},"description":"Typical error response"}},"security":[{"slackAuth":["admin.conversations:write"]}],"tags":["admin.conversations","admin"]}},"/admin.conversations.unarchive":{"post":{"description":"Unarchive a public or private channel.","externalDocs":{"description":"API method documentation","url":"https://api.slack.com/methods/admin.conversations.unarchive"},"operationId":"admin_conversations_unarchive","parameters":[{"description":"Authentication token. Requires scope: `admin.conversations:write`","in":"header","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"channel_id":{"description":"The channel to unarchive.","type":"string"}},"required":["channel_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"ok":true}}},"schema":{"additionalProperties":false,"description":"Schema for successful response of admin.conversations.unarchive","properties":{"ok":{"$ref":"#/components/schemas/defs_ok_true"}},"required":["ok"],"title":"admin.conversations.unarchive schema","type":"object"}}},"description":"Typical success response"},"default":{"content":{"application/json":{"examples":{"response":{"value":{"error":"invalid_auth","