{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/api.test": { "get": { "tags": [ "Api" ], "operationId": "getApitest", "description": "The parameters and request body are for method: getApitest. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "foo": { "type": "string" }, "error": { "type": "string" } } }, "example": { "foo": "foo", "error": "error" } } } } } }, "/apps.permissions.info": { "get": { "tags": [ "Appspermissions" ], "operationId": "getAppspermissionsinfo", "description": "The parameters and request body are for method: getAppspermissionsinfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "info": { "type": "object", "properties": { "app_home": { "type": "object", "properties": { "resources": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } } }, "scopes": { "type": "array", "items": { "type": "string" } } } }, "channel": { "type": "object", "properties": { "resources": { "type": "object", "properties": { "excluded_ids": { "type": "object" }, "ids": { "type": "array", "items": { "type": "string" } }, "wildcard": { "type": "boolean" } } }, "scopes": { "type": "array", "items": { "type": "string" } } } }, "group": { "type": "object", "properties": { "resources": { "type": "object", "properties": { "ids": { "type": "object" } } }, "scopes": { "type": "object" } } }, "im": { "type": "object", "properties": { "resources": { "type": "object", "properties": { "ids": { "type": "object" } } }, "scopes": { "type": "object" } } }, "mpim": { "type": "object", "properties": { "resources": { "type": "object", "properties": { "ids": { "type": "object" } } }, "scopes": { "type": "object" } } }, "team": { "type": "object", "properties": { "resources": { "type": "object", "properties": { "ids": { "type": "object" } } }, "scopes": { "type": "object" } } } } }, "ok": { "type": "boolean" } } }, "example": { "info": { "app_home": { "resources": { "ids": [ "D0C0NU1Q8", "D0BH95DLH" ] }, "scopes": [ "chat:write", "im:history", "im:read" ] }, "channel": { "resources": { "excluded_ids": [], "ids": [ "C061FA5PB" ], "wildcard": false }, "scopes": [ "channels:read" ] }, "group": { "resources": { "ids": [] }, "scopes": [] }, "im": { "resources": { "ids": [] }, "scopes": [] }, "mpim": { "resources": { "ids": [] }, "scopes": [] }, "team": { "resources": { "ids": [] }, "scopes": [] } }, "ok": true } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/apps.permissions.request": { "get": { "tags": [ "Appspermissions" ], "operationId": "getAppspermissionsrequest", "description": "The parameters and request body are for method: getAppspermissionsrequest. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "scopes", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "triggerId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/apps.permissions.resources.list": { "get": { "tags": [ "Appspermissionsresources" ], "operationId": "getAppspermissionsresourceslist", "description": "The parameters and request body are for method: getAppspermissionsresourceslist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "resources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } } } }, "response_metadata": { "type": "object", "properties": { "next_cursor": { "type": "string" } } } } }, "example": { "ok": true, "resources": [ { "id": "T0DES3UAN", "type": "team" }, { "id": "D024BFF1M", "type": "app_home" }, { "id": "C024BE91L", "type": "channel" } ], "response_metadata": { "next_cursor": "dGVhbTpDMUg5UkVTR0w=" } } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/apps.permissions.scopes.list": { "get": { "tags": [ "Appspermissionsscopes" ], "operationId": "getAppspermissionsscopeslist", "description": "The parameters and request body are for method: getAppspermissionsscopeslist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "scopes": { "type": "object", "properties": { "app_home": { "type": "array", "items": { "type": "string" } }, "channel": { "type": "array", "items": { "type": "string" } }, "group": { "type": "array", "items": { "type": "string" } }, "im": { "type": "array", "items": { "type": "string" } }, "mpim": { "type": "array", "items": { "type": "string" } }, "team": { "type": "array", "items": { "type": "string" } }, "user": { "type": "object" } } } } }, "example": { "ok": true, "scopes": { "app_home": [ "chat:write", "im:history", "im:read" ], "channel": [ "channels:history", "chat:write" ], "group": [ "chat:write" ], "im": [ "chat:write" ], "mpim": [ "chat:write" ], "team": [ "users:read" ], "user": [] } } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/auth.revoke": { "get": { "tags": [ "Auth" ], "operationId": "getAuthrevoke", "description": "The parameters and request body are for method: getAuthrevoke. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "revoked": { "type": "boolean" } } }, "example": { "ok": true, "revoked": true } } } } }, "parameters": [ { "name": "test", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/auth.test": { "get": { "tags": [ "Auth" ], "operationId": "getAuthtest", "description": "The parameters and request body are for method: getAuthtest. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "team": { "type": "string" }, "team_id": { "type": "string" }, "url": { "type": "string" }, "user": { "type": "string" }, "user_id": { "type": "string" } } }, "example": { "ok": true, "team": "Subarachnoid Workspace", "team_id": "T12345678", "url": "https://subarachnoid.slack.com/", "user": "grace", "user_id": "W12345678" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/bots.info": { "get": { "tags": [ "Bots" ], "operationId": "getBotsinfo", "description": "The parameters and request body are for method: getBotsinfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "bot": { "type": "object", "properties": { "app_id": { "type": "string" }, "deleted": { "type": "boolean" }, "icons": { "type": "object", "properties": { "image_36": { "type": "string" }, "image_48": { "type": "string" }, "image_72": { "type": "string" } } }, "id": { "type": "string" }, "name": { "type": "string" }, "updated": { "type": "number" } } }, "ok": { "type": "boolean" } } }, "example": { "bot": { "app_id": "A061BLERW", "deleted": false, "icons": { "image_36": "https://...", "image_48": "https://...", "image_72": "https://..." }, "id": "B061F7JQ1", "name": "commandeer", "updated": 1449272004 }, "ok": true } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "bot", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/channels.archive": { "post": { "tags": [ "Channels" ], "operationId": "postChannelsarchive", "description": "The parameters and request body are for method: postChannelsarchive. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/channels.create": { "post": { "tags": [ "Channels" ], "operationId": "postChannelscreate", "description": "The parameters and request body are for method: postChannelscreate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "created": { "type": "number" }, "creator": { "type": "string" }, "id": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_channel": { "type": "boolean" }, "is_general": { "type": "boolean" }, "is_member": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "last_read": { "type": "string" }, "latest": { "type": "object" }, "members": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "previous_names": { "type": "object" }, "purpose": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "topic": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "unread_count": { "type": "number" }, "unread_count_display": { "type": "number" } } }, "ok": { "type": "boolean" } } }, "example": { "channel": { "created": 1502833204, "creator": "U061F7AUR", "id": "C0DEL09A5", "is_archived": false, "is_channel": true, "is_general": false, "is_member": true, "is_mpim": false, "is_org_shared": false, "is_private": false, "is_shared": false, "last_read": "0000000000.000000", "latest": null, "members": [ "U061F7AUR" ], "name": "endeavor", "name_normalized": "endeavor", "previous_names": [], "purpose": { "creator": "", "last_set": 0, "value": "" }, "topic": { "creator": "", "last_set": 0, "value": "" }, "unread_count": 0, "unread_count_display": 0 }, "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "validate": { "type": "string" }, "name": { "type": "string" } } }, "example": { "validate": "validate", "name": "name" } } } } } }, "/channels.history": { "get": { "tags": [ "Channels" ], "operationId": "getChannelshistory", "description": "The parameters and request body are for method: getChannelshistory. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "latest": { "type": "string" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" } } } }, "ok": { "type": "boolean" } } }, "example": { "has_more": false, "latest": "1358547726.000003", "messages": [ { "text": "Hello", "ts": "1358546515.000008", "type": "message", "user": "U2147483896" }, { "is_starred": true, "reactions": [ { "count": 3, "name": "space_invader", "users": [ "U1", "U2", "U3" ] }, { "count": 5, "name": "sweet_potato", "users": [ "U1", "U2", "U3", "U4", "U5" ] } ], "text": "World", "ts": "1358546515.000007", "type": "message", "user": "U2147483896" }, { "ts": "1358546515.000007", "type": "something_else" }, { "attachments": [ { "fallback": "This is an attachment fallback", "id": 1, "text": "Don't get too attached" } ], "bot_id": "B19LU7CSY", "subtype": "bot_message", "text": "Containment unit is 98% full", "ts": "1503435956.000247", "type": "message", "username": "ecto1138" } ], "ok": true } } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "unreads", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "inclusive", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "oldest", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "latest", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/channels.info": { "get": { "tags": [ "Channels" ], "operationId": "getChannelsinfo", "description": "The parameters and request body are for method: getChannelsinfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "created": { "type": "number" }, "creator": { "type": "string" }, "id": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_channel": { "type": "boolean" }, "is_general": { "type": "boolean" }, "is_member": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "last_read": { "type": "string" }, "latest": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "type": "object", "properties": { "fallback": { "type": "string" }, "id": { "type": "number" }, "text": { "type": "string" } } } }, "bot_id": { "type": "string" }, "subtype": { "type": "string" }, "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "username": { "type": "string" } } }, "members": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "previous_names": { "type": "array", "items": { "type": "string" } }, "purpose": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "topic": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "unread_count": { "type": "number" }, "unread_count_display": { "type": "number" } } }, "ok": { "type": "boolean" } } }, "example": { "channel": { "created": 1466025154, "creator": "U0G9QF9C6", "id": "C1H9RESGL", "is_archived": false, "is_channel": true, "is_general": false, "is_member": true, "is_mpim": false, "is_org_shared": false, "is_private": false, "is_shared": false, "last_read": "1503435939.000101", "latest": { "attachments": [ { "fallback": "This is an attachment fallback", "id": 1, "text": "Don't get too attached" } ], "bot_id": "B19LU7CSY", "subtype": "bot_message", "text": "Containment unit is 98% full", "ts": "1503435956.000247", "type": "message", "username": "ecto1138" }, "members": [ "U0G9QF9C6", "U1QNSQB9U" ], "name": "busting", "name_normalized": "busting", "previous_names": [ "dusting" ], "purpose": { "creator": "U0G9QF9C6", "last_set": 1503435128, "value": "Discuss busting ghosts" }, "topic": { "creator": "U0G9QF9C6", "last_set": 1503435128, "value": "Spiritual containment strategies" }, "unread_count": 1, "unread_count_display": 1 }, "ok": true } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeLocale", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/channels.invite": { "post": { "tags": [ "Channels" ], "operationId": "postChannelsinvite", "description": "The parameters and request body are for method: postChannelsinvite. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "created": { "type": "number" }, "creator": { "type": "string" }, "id": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_channel": { "type": "boolean" }, "is_general": { "type": "boolean" }, "is_member": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "last_read": { "type": "string" }, "latest": { "type": "object", "properties": { "subtype": { "type": "string" }, "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" } } }, "members": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "previous_names": { "type": "object" }, "purpose": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "topic": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "unread_count": { "type": "number" }, "unread_count_display": { "type": "number" } } }, "ok": { "type": "boolean" } } }, "example": { "channel": { "created": 1466025154, "creator": "U0G9QF9C6", "id": "C1H9RESGL", "is_archived": false, "is_channel": true, "is_general": false, "is_member": true, "is_mpim": false, "is_org_shared": false, "is_private": false, "is_shared": false, "last_read": "1503435963.000307", "latest": { "subtype": "channel_leave", "text": "<@U1QNSQB9U|protobot> has left the channel", "ts": "1503435963.000307", "type": "message", "user": "U1QNSQB9U" }, "members": [ "U0G9QF9C6", "U1QNSQB9U" ], "name": "busting", "name_normalized": "busting", "previous_names": [], "purpose": { "creator": "U0G9QF9C6", "last_set": 1503435128, "value": "My Purpose" }, "topic": { "creator": "U0G9QF9C6", "last_set": 1503435128, "value": "My Topic" }, "unread_count": 0, "unread_count_display": 0 }, "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "user": "user", "channel": "channel" } } } } } }, "/channels.join": { "post": { "tags": [ "Channels" ], "operationId": "postChannelsjoin", "description": "The parameters and request body are for method: postChannelsjoin. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "already_in_channel": { "type": "boolean" }, "channel": { "type": "object", "properties": { "created": { "type": "number" }, "creator": { "type": "string" }, "id": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_channel": { "type": "boolean" }, "is_general": { "type": "boolean" }, "is_member": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "members": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "previous_names": { "type": "object" }, "purpose": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "topic": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } } } }, "ok": { "type": "boolean" } } }, "example": { "already_in_channel": true, "channel": { "created": 1466025154, "creator": "U0G9QF9C6", "id": "C1H9RESGL", "is_archived": false, "is_channel": true, "is_general": false, "is_member": true, "is_mpim": false, "is_org_shared": false, "is_private": false, "is_shared": false, "members": [ "U0G9QF9C6", "U1QNSQB9U" ], "name": "busting", "name_normalized": "busting", "previous_names": [], "purpose": { "creator": "U0G9QF9C6", "last_set": 1503435128, "value": "My Purpose" }, "topic": { "creator": "U0G9QF9C6", "last_set": 1503435128, "value": "My Topic" } }, "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "validate": { "type": "string" }, "name": { "type": "string" } } }, "example": { "validate": "validate", "name": "name" } } } } } }, "/channels.kick": { "post": { "tags": [ "Channels" ], "operationId": "postChannelskick", "description": "The parameters and request body are for method: postChannelskick. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "user": "user", "channel": "channel" } } } } } }, "/channels.leave": { "post": { "tags": [ "Channels" ], "operationId": "postChannelsleave", "description": "The parameters and request body are for method: postChannelsleave. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/channels.list": { "get": { "tags": [ "Channels" ], "operationId": "getChannelslist", "description": "The parameters and request body are for method: getChannelslist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "object", "properties": { "created": { "type": "number" }, "creator": { "type": "string" }, "id": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_channel": { "type": "boolean" }, "is_general": { "type": "boolean" }, "is_member": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "members": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "num_members": { "type": "number" }, "previous_names": { "type": "object" }, "purpose": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "topic": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } } } } }, "ok": { "type": "boolean" }, "response_metadata": { "type": "object", "properties": { "next_cursor": { "type": "string" } } } } }, "example": { "channels": [ { "created": 1449709280, "creator": "U0G9QF9C6", "id": "C0G9QF9GW", "is_archived": false, "is_channel": true, "is_general": false, "is_member": true, "is_mpim": false, "is_org_shared": false, "is_private": false, "is_shared": false, "members": [ "U0G9QF9C6", "U0G9WFXNZ" ], "name": "random", "name_normalized": "random", "num_members": 2, "previous_names": [], "purpose": { "creator": "", "last_set": 0, "value": "A place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber you'd prefer to keep out of more focused work-related channels." }, "topic": { "creator": "U0G9QF9C6", "last_set": 1449709352, "value": "Other stuff" } }, { "created": 1449709280, "creator": "U0G9QF9C6", "id": "C0G9QKBBL", "is_archived": false, "is_channel": true, "is_general": true, "is_member": true, "is_mpim": false, "is_org_shared": false, "is_private": false, "is_shared": false, "members": [ "U0G9QF9C6", "U0G9WFXNZ" ], "name": "general", "name_normalized": "general", "num_members": 2, "previous_names": [], "purpose": { "creator": "U0G9QF9C6", "last_set": 1449709334, "value": "To talk about anything!" }, "topic": { "creator": "U0G9QF9C6", "last_set": 1449709364, "value": "Talk about anything!" } } ], "ok": true, "response_metadata": { "next_cursor": "dGVhbTpDMUg5UkVTR0w=" } } } } } }, "parameters": [ { "name": "excludeMembers", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "excludeArchived", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/channels.mark": { "post": { "tags": [ "Channels" ], "operationId": "postChannelsmark", "description": "The parameters and request body are for method: postChannelsmark. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ts": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "ts": "ts", "channel": "channel" } } } } } }, "/channels.rename": { "post": { "tags": [ "Channels" ], "operationId": "postChannelsrename", "description": "The parameters and request body are for method: postChannelsrename. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "created": { "type": "number" }, "creator": { "type": "string" }, "id": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_channel": { "type": "boolean" }, "is_general": { "type": "boolean" }, "is_member": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "members": { "type": "object" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "previous_names": { "type": "array", "items": { "type": "string" } }, "purpose": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "topic": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "unlinked": { "type": "number" } } }, "ok": { "type": "boolean" } } }, "example": { "channel": { "created": 1477445146, "creator": "U2U85N1RZ", "id": "C2U875RJN", "is_archived": false, "is_channel": true, "is_general": false, "is_member": false, "is_mpim": false, "is_org_shared": false, "is_private": false, "is_shared": false, "members": [], "name": "humans-and-bots", "name_normalized": "humans-and-bots", "previous_names": [ "humans" ], "purpose": { "creator": "U2U85N1RZ", "last_set": 1509475801, "value": "the purpose of this channel is to bring people and robots together in harmony" }, "topic": { "creator": "U2U85N1RZ", "last_set": 1509475775, "value": "here be robots" }, "unlinked": 0 }, "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "validate": { "type": "string" }, "name": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "validate": "validate", "name": "name", "channel": "channel" } } } } } }, "/channels.replies": { "get": { "tags": [ "Channels" ], "operationId": "getChannelsreplies", "description": "The parameters and request body are for method: getChannelsreplies. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "last_read": { "type": "string" }, "replies": { "type": "array", "items": { "type": "object", "properties": { "ts": { "type": "string" }, "user": { "type": "string" } } } }, "reply_count": { "type": "number" }, "subscribed": { "type": "boolean" }, "text": { "type": "string" }, "thread_ts": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "unread_count": { "type": "number" }, "user": { "type": "string" } } } }, "ok": { "type": "boolean" } } }, "example": { "has_more": false, "messages": [ { "last_read": "1509484885.000082", "replies": [ { "ts": "1509484424.000601", "user": "U2U85N1RZ" }, { "ts": "1509484885.000082", "user": "U2U85N1RZ" } ], "reply_count": 2, "subscribed": true, "text": "This is a channel message", "thread_ts": "1485913694.000025", "ts": "1485913694.000025", "type": "message", "unread_count": 0, "user": "U2X9P5FEL" }, { "parent_user_id": "U2X9P5FEL", "text": "This is a thread reply", "thread_ts": "1485913694.000025", "ts": "1509484424.000601", "type": "message", "user": "U2U85N1RZ" }, { "parent_user_id": "U2X9P5FEL", "text": "This is another thread reply", "thread_ts": "1485913694.000025", "ts": "1509484885.000082", "type": "message", "user": "U2U85N1RZ" } ], "ok": true } } } } }, "parameters": [ { "name": "threadTs", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/channels.setPurpose": { "post": { "tags": [ "Channels" ], "operationId": "postChannelssetPurpose", "description": "The parameters and request body are for method: postChannelssetPurpose. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "purpose": { "type": "string" } } }, "example": { "ok": true, "purpose": "My special purpose" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "purpose": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "purpose": "purpose", "channel": "channel" } } } } } }, "/channels.setTopic": { "post": { "tags": [ "Channels" ], "operationId": "postChannelssetTopic", "description": "The parameters and request body are for method: postChannelssetTopic. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "topic": { "type": "string" } } }, "example": { "ok": true, "topic": "To picture topicality" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "topic": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "topic": "topic", "channel": "channel" } } } } } }, "/channels.unarchive": { "post": { "tags": [ "Channels" ], "operationId": "postChannelsunarchive", "description": "The parameters and request body are for method: postChannelsunarchive. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/chat.delete": { "post": { "tags": [ "Chat" ], "operationId": "postChatdelete", "description": "The parameters and request body are for method: postChatdelete. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" }, "ok": { "type": "boolean" }, "ts": { "type": "string" } } }, "example": { "channel": "C024BE91L", "ok": true, "ts": "1401383885.000061" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "asUser": { "type": "string" }, "ts": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "asUser": "asUser", "ts": "ts", "channel": "channel" } } } } } }, "/chat.getPermalink": { "get": { "tags": [ "Chat" ], "operationId": "getChatgetPermalink", "description": "The parameters and request body are for method: getChatgetPermalink. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" }, "ok": { "type": "boolean" }, "permalink": { "type": "string" } } }, "example": { "channel": "C1H9RESGA", "ok": true, "permalink": "https://ghostbusters.slack.com/archives/C1H9RESGA/p135854651500008" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "messageTs", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/chat.meMessage": { "post": { "tags": [ "Chat" ], "operationId": "postChatmeMessage", "description": "The parameters and request body are for method: postChatmeMessage. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" }, "ok": { "type": "boolean" }, "ts": { "type": "string" } } }, "example": { "channel": "C024BE7LR", "ok": true, "ts": "1417671948.000006" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "text": "text", "channel": "channel" } } } } } }, "/chat.postEphemeral": { "post": { "tags": [ "Chat" ], "operationId": "postChatpostEphemeral", "description": "The parameters and request body are for method: postChatpostEphemeral. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "message_ts": { "type": "string" }, "ok": { "type": "boolean" } } }, "example": { "message_ts": "1502210682.580145", "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachments": { "type": "string" }, "text": { "type": "string" }, "linkNames": { "type": "string" }, "parse": { "type": "string" }, "user": { "type": "string" }, "asUser": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "attachments": "attachments", "text": "text", "linkNames": "linkNames", "parse": "parse", "user": "user", "asUser": "asUser", "channel": "channel" } } } } } }, "/chat.postMessage": { "post": { "tags": [ "Chat" ], "operationId": "postChatpostMessage", "description": "The parameters and request body are for method: postChatpostMessage. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" }, "message": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "type": "object", "properties": { "fallback": { "type": "string" }, "id": { "type": "number" }, "text": { "type": "string" } } } }, "bot_id": { "type": "string" }, "subtype": { "type": "string" }, "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "username": { "type": "string" } } }, "ok": { "type": "boolean" }, "ts": { "type": "string" } } }, "example": { "channel": "C1H9RESGL", "message": { "attachments": [ { "fallback": "This is an attachment's fallback", "id": 1, "text": "This is an attachment" } ], "bot_id": "B19LU7CSY", "subtype": "bot_message", "text": "Here's a message for you", "ts": "1503435956.000247", "type": "message", "username": "ecto1" }, "ok": true, "ts": "1503435956.000247" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string" }, "threadTs": { "type": "string" }, "attachments": { "type": "string" }, "unfurlLinks": { "type": "string" }, "text": { "type": "string" }, "unfurlMedia": { "type": "string" }, "parse": { "type": "string" }, "asUser": { "type": "string" }, "mrkdwn": { "type": "string" }, "iconEmoji": { "type": "string" }, "linkNames": { "type": "string" }, "iconUrl": { "type": "string" }, "channel": { "type": "string" }, "replyBroadcast": { "type": "string" } } }, "example": { "username": "username", "threadTs": "threadTs", "attachments": "attachments", "unfurlLinks": "unfurlLinks", "text": "text", "unfurlMedia": "unfurlMedia", "parse": "parse", "asUser": "asUser", "mrkdwn": "mrkdwn", "iconEmoji": "iconEmoji", "linkNames": "linkNames", "iconUrl": "iconUrl", "channel": "channel", "replyBroadcast": "replyBroadcast" } } } } } }, "/chat.unfurl": { "post": { "tags": [ "Chat" ], "operationId": "postChatunfurl", "description": "The parameters and request body are for method: postChatunfurl. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userAuthMessage": { "type": "string" }, "userAuthRequired": { "type": "string" }, "unfurls": { "type": "string" }, "ts": { "type": "string" }, "userAuthUrl": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "userAuthMessage": "userAuthMessage", "userAuthRequired": "userAuthRequired", "unfurls": "unfurls", "ts": "ts", "userAuthUrl": "userAuthUrl", "channel": "channel" } } } } } }, "/chat.update": { "post": { "tags": [ "Chat" ], "operationId": "postChatupdate", "description": "The parameters and request body are for method: postChatupdate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" }, "ok": { "type": "boolean" }, "text": { "type": "string" }, "ts": { "type": "string" } } }, "example": { "channel": "C024BE91L", "ok": true, "text": "Updated text you carefully authored", "ts": "1401383885.000061" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachments": { "type": "string" }, "text": { "type": "string" }, "ts": { "type": "string" }, "parse": { "type": "string" }, "asUser": { "type": "string" }, "linkNames": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "attachments": "attachments", "text": "text", "ts": "ts", "parse": "parse", "asUser": "asUser", "linkNames": "linkNames", "channel": "channel" } } } } } }, "/conversations.archive": { "post": { "tags": [ "Conversations" ], "operationId": "postConversationsarchive", "description": "The parameters and request body are for method: postConversationsarchive. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/conversations.close": { "post": { "tags": [ "Conversations" ], "operationId": "postConversationsclose", "description": "The parameters and request body are for method: postConversationsclose. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/conversations.create": { "post": { "tags": [ "Conversations" ], "operationId": "postConversationscreate", "description": "The parameters and request body are for method: postConversationscreate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "created": { "type": "number" }, "creator": { "type": "string" }, "id": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_channel": { "type": "boolean" }, "is_ext_shared": { "type": "boolean" }, "is_general": { "type": "boolean" }, "is_group": { "type": "boolean" }, "is_im": { "type": "boolean" }, "is_member": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_pending_ext_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "last_read": { "type": "string" }, "latest": { "type": "object" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "pending_shared": { "type": "object" }, "previous_names": { "type": "object" }, "priority": { "type": "number" }, "purpose": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "topic": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "unlinked": { "type": "number" }, "unread_count": { "type": "number" }, "unread_count_display": { "type": "number" } } }, "ok": { "type": "boolean" } } }, "example": { "channel": { "created": 1504554479, "creator": "U0123456", "id": "C0EAQDV4Z", "is_archived": false, "is_channel": true, "is_ext_shared": false, "is_general": false, "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, "last_read": "0000000000.000000", "latest": null, "name": "endeavor", "name_normalized": "endeavor", "pending_shared": [], "previous_names": [], "priority": 0, "purpose": { "creator": "", "last_set": 0, "value": "" }, "topic": { "creator": "", "last_set": 0, "value": "" }, "unlinked": 0, "unread_count": 0, "unread_count_display": 0 }, "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "isPrivate": { "type": "string" } } }, "example": { "name": "name", "isPrivate": "isPrivate" } } } } } }, "/conversations.history": { "get": { "tags": [ "Conversations" ], "operationId": "getConversationshistory", "description": "The parameters and request body are for method: getConversationshistory. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" } } } }, "ok": { "type": "boolean" }, "pin_count": { "type": "number" }, "response_metadata": { "type": "object", "properties": { "next_cursor": { "type": "string" } } } } }, "example": { "has_more": true, "messages": [ { "text": "I find you punny and would like to smell your nose letter", "ts": "1512085950.000216", "type": "message", "user": "U012AB3CDE" }, { "text": "What, you want to smell my shoes better?", "ts": "1512104434.000490", "type": "message", "user": "U061F7AUR" } ], "ok": true, "pin_count": 0, "response_metadata": { "next_cursor": "bmV4dF90czoxNTEyMDg1ODYxMDAwNTQz" } } } } } }, "parameters": [ { "name": "inclusive", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "oldest", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "latest", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/conversations.info": { "get": { "tags": [ "Conversations" ], "operationId": "getConversationsinfo", "description": "The parameters and request body are for method: getConversationsinfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "created": { "type": "number" }, "creator": { "type": "string" }, "id": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_channel": { "type": "boolean" }, "is_ext_shared": { "type": "boolean" }, "is_general": { "type": "boolean" }, "is_group": { "type": "boolean" }, "is_im": { "type": "boolean" }, "is_member": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_pending_ext_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_read_only": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "last_read": { "type": "string" }, "locale": { "type": "string" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "num_members": { "type": "number" }, "pending_shared": { "type": "object" }, "previous_names": { "type": "array", "items": { "type": "string" } }, "purpose": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "topic": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "unlinked": { "type": "number" } } }, "ok": { "type": "boolean" } } }, "example": { "channel": { "created": 1449252889, "creator": "W012A3BCD", "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_read_only": false, "is_shared": false, "last_read": "1502126650.228446", "locale": "en-US", "name": "general", "name_normalized": "general", "num_members": 23, "pending_shared": [], "previous_names": [ "specifics", "abstractions", "etc" ], "purpose": { "creator": "W012A3BCD", "last_set": 1449709364, "value": "This part of the workspace is for fun. Make fun here." }, "topic": { "creator": "W012A3BCD", "last_set": 1449709364, "value": "For public discussion of generalities" }, "unlinked": 0 }, "ok": true } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeLocale", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/conversations.invite": { "post": { "tags": [ "Conversations" ], "operationId": "postConversationsinvite", "description": "The parameters and request body are for method: postConversationsinvite. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "created": { "type": "number" }, "creator": { "type": "string" }, "id": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_channel": { "type": "boolean" }, "is_ext_shared": { "type": "boolean" }, "is_general": { "type": "boolean" }, "is_group": { "type": "boolean" }, "is_im": { "type": "boolean" }, "is_member": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_pending_ext_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_read_only": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "last_read": { "type": "string" }, "locale": { "type": "string" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "num_members": { "type": "number" }, "pending_shared": { "type": "object" }, "previous_names": { "type": "array", "items": { "type": "string" } }, "purpose": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "topic": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "unlinked": { "type": "number" } } }, "ok": { "type": "boolean" } } }, "example": { "channel": { "created": 1449252889, "creator": "W012A3BCD", "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_read_only": false, "is_shared": false, "last_read": "1502126650.228446", "locale": "en-US", "name": "general", "name_normalized": "general", "num_members": 23, "pending_shared": [], "previous_names": [ "specifics", "abstractions", "etc" ], "purpose": { "creator": "W012A3BCD", "last_set": 1449709364, "value": "This part of the workspace is for fun. Make fun here." }, "topic": { "creator": "W012A3BCD", "last_set": 1449709364, "value": "For public discussion of generalities" }, "unlinked": 0 }, "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "users": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "users": "users", "channel": "channel" } } } } } }, "/conversations.join": { "post": { "tags": [ "Conversations" ], "operationId": "postConversationsjoin", "description": "The parameters and request body are for method: postConversationsjoin. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "created": { "type": "number" }, "creator": { "type": "string" }, "id": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_channel": { "type": "boolean" }, "is_ext_shared": { "type": "boolean" }, "is_general": { "type": "boolean" }, "is_group": { "type": "boolean" }, "is_im": { "type": "boolean" }, "is_member": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_pending_ext_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "pending_shared": { "type": "object" }, "previous_names": { "type": "object" }, "purpose": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "topic": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "unlinked": { "type": "number" } } }, "ok": { "type": "boolean" }, "response_metadata": { "type": "object", "properties": { "warnings": { "type": "array", "items": { "type": "string" } } } }, "warning": { "type": "string" } } }, "example": { "channel": { "created": 1449252889, "creator": "U061F7AUR", "id": "C061EG9SL", "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", "pending_shared": [], "previous_names": [], "purpose": { "creator": "", "last_set": 0, "value": "For widget discussion" }, "topic": { "creator": "", "last_set": 0, "value": "Which widget do you worry about?" }, "unlinked": 0 }, "ok": true, "response_metadata": { "warnings": [ "already_in_channel" ] }, "warning": "already_in_channel" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/conversations.kick": { "post": { "tags": [ "Conversations" ], "operationId": "postConversationskick", "description": "The parameters and request body are for method: postConversationskick. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "user": "user", "channel": "channel" } } } } } }, "/conversations.leave": { "post": { "tags": [ "Conversations" ], "operationId": "postConversationsleave", "description": "The parameters and request body are for method: postConversationsleave. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/conversations.list": { "get": { "tags": [ "Conversations" ], "operationId": "getConversationslist", "description": "The parameters and request body are for method: getConversationslist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "object", "properties": { "created": { "type": "number" }, "creator": { "type": "string" }, "id": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_channel": { "type": "boolean" }, "is_ext_shared": { "type": "boolean" }, "is_general": { "type": "boolean" }, "is_group": { "type": "boolean" }, "is_im": { "type": "boolean" }, "is_member": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_pending_ext_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "num_members": { "type": "number" }, "pending_shared": { "type": "object" }, "previous_names": { "type": "object" }, "purpose": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "topic": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "unlinked": { "type": "number" } } } }, "ok": { "type": "boolean" }, "response_metadata": { "type": "object", "properties": { "next_cursor": { "type": "string" } } } } }, "example": { "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 }, { "created": 1449252889, "creator": "U061F7AUR", "id": "C061EG9T2", "is_archived": false, "is_channel": true, "is_ext_shared": false, "is_general": false, "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": "random", "name_normalized": "random", "num_members": 4, "pending_shared": [], "previous_names": [], "purpose": { "creator": "", "last_set": 0, "value": "A place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber you'd prefer to keep out of more focused work-related channels." }, "topic": { "creator": "", "last_set": 0, "value": "Non-work banter and water cooler conversation" }, "unlinked": 0 } ], "ok": true, "response_metadata": { "next_cursor": "dGVhbTpDMDYxRkE1UEI=" } } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "excludeArchived", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "types", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/conversations.members": { "get": { "tags": [ "Conversations" ], "operationId": "getConversationsmembers", "description": "The parameters and request body are for method: getConversationsmembers. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "members": { "type": "array", "items": { "type": "string" } }, "ok": { "type": "boolean" }, "response_metadata": { "type": "object", "properties": { "next_cursor": { "type": "string" } } } } }, "example": { "members": [ "U023BECGF", "U061F7AUR", "W012A3CDE" ], "ok": true, "response_metadata": { "next_cursor": "e3VzZXJfaWQ6IFcxMjM0NTY3fQ==" } } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/conversations.open": { "post": { "tags": [ "Conversations" ], "operationId": "postConversationsopen", "description": "The parameters and request body are for method: postConversationsopen. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "id": { "type": "string" } } }, "ok": { "type": "boolean" } } }, "example": { "channel": { "id": "D069C7QFK" }, "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "returnIm": { "type": "string" }, "users": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "returnIm": "returnIm", "users": "users", "channel": "channel" } } } } } }, "/conversations.rename": { "post": { "tags": [ "Conversations" ], "operationId": "postConversationsrename", "description": "The parameters and request body are for method: postConversationsrename. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "created": { "type": "number" }, "creator": { "type": "string" }, "id": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_channel": { "type": "boolean" }, "is_ext_shared": { "type": "boolean" }, "is_general": { "type": "boolean" }, "is_group": { "type": "boolean" }, "is_im": { "type": "boolean" }, "is_member": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_pending_ext_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_read_only": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "last_read": { "type": "string" }, "locale": { "type": "string" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "num_members": { "type": "number" }, "pending_shared": { "type": "object" }, "previous_names": { "type": "array", "items": { "type": "string" } }, "purpose": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "topic": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "unlinked": { "type": "number" } } }, "ok": { "type": "boolean" } } }, "example": { "channel": { "created": 1449252889, "creator": "W012A3BCD", "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_read_only": false, "is_shared": false, "last_read": "1502126650.228446", "locale": "en-US", "name": "general", "name_normalized": "general", "num_members": 23, "pending_shared": [], "previous_names": [ "specifics", "abstractions", "etc" ], "purpose": { "creator": "W012A3BCD", "last_set": 1449709364, "value": "This part of the workspace is for fun. Make fun here." }, "topic": { "creator": "W012A3BCD", "last_set": 1449709364, "value": "For public discussion of generalities" }, "unlinked": 0 }, "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "name": "name", "channel": "channel" } } } } } }, "/conversations.replies": { "get": { "tags": [ "Conversations" ], "operationId": "getConversationsreplies", "description": "The parameters and request body are for method: getConversationsreplies. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "last_read": { "type": "string" }, "replies": { "type": "array", "items": { "type": "object", "properties": { "ts": { "type": "string" }, "user": { "type": "string" } } } }, "reply_count": { "type": "number" }, "subscribed": { "type": "boolean" }, "text": { "type": "string" }, "thread_ts": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "unread_count": { "type": "number" }, "user": { "type": "string" } } } }, "ok": { "type": "boolean" }, "response_metadata": { "type": "object", "properties": { "next_cursor": { "type": "string" } } } } }, "example": { "has_more": true, "messages": [ { "last_read": "1484678597.521003", "replies": [ { "ts": "1483037603.017503", "user": "U061F7AUR" }, { "ts": "1483051909.018632", "user": "U061F7AUR" }, { "ts": "1483125339.020269", "user": "U061F7AUR" } ], "reply_count": 3, "subscribed": true, "text": "island", "thread_ts": "1482960137.003543", "ts": "1482960137.003543", "type": "message", "unread_count": 0, "user": "U061F7AUR" }, { "parent_user_id": "U061F7AUR", "text": "one island", "thread_ts": "1482960137.003543", "ts": "1483037603.017503", "type": "message", "user": "U061F7AUR" }, { "parent_user_id": "U061F7AUR", "text": "two island", "thread_ts": "1482960137.003543", "ts": "1483051909.018632", "type": "message", "user": "U061F7AUR" }, { "parent_user_id": "U061F7AUR", "text": "three for the land", "thread_ts": "1482960137.003543", "ts": "1483125339.020269", "type": "message", "user": "U061F7AUR" } ], "ok": true, "response_metadata": { "next_cursor": "bmV4dF90czoxNDg0Njc4MjkwNTE3MDkx" } } } } } }, "parameters": [ { "name": "inclusive", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ts", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "oldest", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "latest", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/conversations.setPurpose": { "post": { "tags": [ "Conversations" ], "operationId": "postConversationssetPurpose", "description": "The parameters and request body are for method: postConversationssetPurpose. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "purpose": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "purpose": "purpose", "channel": "channel" } } } } } }, "/conversations.setTopic": { "post": { "tags": [ "Conversations" ], "operationId": "postConversationssetTopic", "description": "The parameters and request body are for method: postConversationssetTopic. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "topic": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "topic": "topic", "channel": "channel" } } } } } }, "/conversations.unarchive": { "post": { "tags": [ "Conversations" ], "operationId": "postConversationsunarchive", "description": "The parameters and request body are for method: postConversationsunarchive. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/dialog.open": { "get": { "tags": [ "Dialog" ], "operationId": "getDialogopen", "description": "The parameters and request body are for method: getDialogopen. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "dialog", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "triggerId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dnd.endDnd": { "post": { "tags": [ "Dnd" ], "operationId": "postDndendDnd", "description": "The parameters and request body are for method: postDndendDnd. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dnd.endSnooze": { "post": { "tags": [ "Dnd" ], "operationId": "postDndendSnooze", "description": "The parameters and request body are for method: postDndendSnooze. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dnd.info": { "get": { "tags": [ "Dnd" ], "operationId": "getDndinfo", "description": "The parameters and request body are for method: getDndinfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dnd.setSnooze": { "post": { "tags": [ "Dnd" ], "operationId": "postDndsetSnooze", "description": "The parameters and request body are for method: postDndsetSnooze. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/dnd.teamInfo": { "get": { "tags": [ "Dnd" ], "operationId": "getDndteamInfo", "description": "The parameters and request body are for method: getDndteamInfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "users": { "type": "object", "properties": { "U023BECGF": { "type": "object", "properties": { "dnd_enabled": { "type": "boolean" }, "next_dnd_end_ts": { "type": "number" }, "next_dnd_start_ts": { "type": "number" } } }, "W058CJVAA": { "type": "object", "properties": { "dnd_enabled": { "type": "boolean" }, "next_dnd_end_ts": { "type": "number" }, "next_dnd_start_ts": { "type": "number" } } } } } } }, "example": { "ok": true, "users": { "U023BECGF": { "dnd_enabled": true, "next_dnd_end_ts": 1450423800, "next_dnd_start_ts": 1450387800 }, "W058CJVAA": { "dnd_enabled": false, "next_dnd_end_ts": 1, "next_dnd_start_ts": 1 } } } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "users", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/emoji.list": { "get": { "tags": [ "Emoji" ], "operationId": "getEmojilist", "description": "The parameters and request body are for method: getEmojilist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/files.comments.add": { "post": { "tags": [ "Filescomments" ], "operationId": "postFilescommentsadd", "description": "The parameters and request body are for method: postFilescommentsadd. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "comment": { "type": "object", "properties": { "channel": { "type": "string" }, "comment": { "type": "string" }, "created": { "type": "number" }, "id": { "type": "string" }, "timestamp": { "type": "number" }, "user": { "type": "string" } } }, "ok": { "type": "boolean" } } }, "example": { "comment": { "channel": "C1234467890", "comment": "Everyone should take a moment to read this file.", "created": 1356032811, "id": "Fc1234567890", "timestamp": 1356032811, "user": "U1234567890" }, "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "comment": { "type": "string" }, "file": { "type": "string" } } }, "example": { "comment": "comment", "file": "file" } } } } } }, "/files.comments.delete": { "post": { "tags": [ "Filescomments" ], "operationId": "postFilescommentsdelete", "description": "The parameters and request body are for method: postFilescommentsdelete. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "file": { "type": "string" } } }, "example": { "id": "id", "file": "file" } } } } } }, "/files.comments.edit": { "post": { "tags": [ "Filescomments" ], "operationId": "postFilescommentsedit", "description": "The parameters and request body are for method: postFilescommentsedit. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "team": { "type": "string" }, "team_id": { "type": "string" }, "url": { "type": "string" }, "user": { "type": "string" }, "user_id": { "type": "string" } } }, "example": { "ok": true, "team": "Subarachnoid Workspace", "team_id": "T12345678", "url": "https://subarachnoid.slack.com/", "user": "grace", "user_id": "W12345678" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "comment": { "type": "string" }, "id": { "type": "string" }, "file": { "type": "string" } } }, "example": { "comment": "comment", "id": "id", "file": "file" } } } } } }, "/files.delete": { "post": { "tags": [ "Files" ], "operationId": "postFilesdelete", "description": "The parameters and request body are for method: postFilesdelete. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string" } } }, "example": { "file": "file" } } } } } }, "/files.info": { "get": { "tags": [ "Files" ], "operationId": "getFilesinfo", "description": "The parameters and request body are for method: getFilesinfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "file", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/files.list": { "get": { "tags": [ "Files" ], "operationId": "getFileslist", "description": "The parameters and request body are for method: getFileslist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tsTo", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tsFrom", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "types", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/files.revokePublicURL": { "post": { "tags": [ "Files" ], "operationId": "postFilesrevokePublicURL", "description": "The parameters and request body are for method: postFilesrevokePublicURL. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string" } } }, "example": { "file": "file" } } } } } }, "/files.sharedPublicURL": { "post": { "tags": [ "Files" ], "operationId": "postFilessharedPublicURL", "description": "The parameters and request body are for method: postFilessharedPublicURL. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string" } } }, "example": { "file": "file" } } } } } }, "/files.upload": { "post": { "tags": [ "Files" ], "operationId": "postFilesupload", "description": "The parameters and request body are for method: postFilesupload. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channels": { "type": "string" }, "title": { "type": "string" }, "initialComment": { "type": "string" }, "filetype": { "type": "string" }, "filename": { "type": "string" }, "content": { "type": "string" }, "file": { "type": "string" }, "threadTs": { "type": "string" } } }, "example": { "channels": "channels", "title": "title", "initialComment": "initialComment", "filetype": "filetype", "filename": "filename", "content": "content", "file": "file", "threadTs": "threadTs" } } } } } }, "/groups.archive": { "post": { "tags": [ "Groups" ], "operationId": "postGroupsarchive", "description": "The parameters and request body are for method: postGroupsarchive. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/groups.create": { "post": { "tags": [ "Groups" ], "operationId": "postGroupscreate", "description": "The parameters and request body are for method: postGroupscreate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "validate": { "type": "string" }, "name": { "type": "string" } } }, "example": { "validate": "validate", "name": "name" } } } } } }, "/groups.createChild": { "post": { "tags": [ "Groups" ], "operationId": "postGroupscreateChild", "description": "The parameters and request body are for method: postGroupscreateChild. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/groups.history": { "get": { "tags": [ "Groups" ], "operationId": "getGroupshistory", "description": "The parameters and request body are for method: getGroupshistory. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "latest": { "type": "string" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" } } } }, "ok": { "type": "boolean" } } }, "example": { "has_more": false, "latest": "1358547726.000003", "messages": [ { "text": "Hello", "ts": "1358546515.000008", "type": "message", "user": "U2147483896" }, { "is_starred": true, "text": "World", "ts": "1358546515.000007", "type": "message", "user": "U2147483896" }, { "ts": "1358546515.000007", "type": "something_else" } ], "ok": true } } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "unreads", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "inclusive", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "oldest", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "latest", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/groups.info": { "get": { "tags": [ "Groups" ], "operationId": "getGroupsinfo", "description": "The parameters and request body are for method: getGroupsinfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeLocale", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/groups.invite": { "post": { "tags": [ "Groups" ], "operationId": "postGroupsinvite", "description": "The parameters and request body are for method: postGroupsinvite. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "user": "user", "channel": "channel" } } } } } }, "/groups.kick": { "post": { "tags": [ "Groups" ], "operationId": "postGroupskick", "description": "The parameters and request body are for method: postGroupskick. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "user": "user", "channel": "channel" } } } } } }, "/groups.leave": { "post": { "tags": [ "Groups" ], "operationId": "postGroupsleave", "description": "The parameters and request body are for method: postGroupsleave. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/groups.list": { "get": { "tags": [ "Groups" ], "operationId": "getGroupslist", "description": "The parameters and request body are for method: getGroupslist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "excludeMembers", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "excludeArchived", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/groups.mark": { "post": { "tags": [ "Groups" ], "operationId": "postGroupsmark", "description": "The parameters and request body are for method: postGroupsmark. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ts": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "ts": "ts", "channel": "channel" } } } } } }, "/groups.open": { "post": { "tags": [ "Groups" ], "operationId": "postGroupsopen", "description": "The parameters and request body are for method: postGroupsopen. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/groups.rename": { "post": { "tags": [ "Groups" ], "operationId": "postGroupsrename", "description": "The parameters and request body are for method: postGroupsrename. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "validate": { "type": "string" }, "name": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "validate": "validate", "name": "name", "channel": "channel" } } } } } }, "/groups.replies": { "get": { "tags": [ "Groups" ], "operationId": "getGroupsreplies", "description": "The parameters and request body are for method: getGroupsreplies. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" } } } }, "ok": { "type": "boolean" } } }, "example": { "messages": [ { "text": "Hello", "ts": "1358546515.000008", "type": "message", "user": "U2147483896" }, { "is_starred": true, "text": "World", "ts": "1358546515.000007", "type": "message", "user": "U2147483896" }, { "ts": "1358546515.000007", "type": "something_else" } ], "ok": true } } } } }, "parameters": [ { "name": "threadTs", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/groups.setPurpose": { "post": { "tags": [ "Groups" ], "operationId": "postGroupssetPurpose", "description": "The parameters and request body are for method: postGroupssetPurpose. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "purpose": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "purpose": "purpose", "channel": "channel" } } } } } }, "/groups.setTopic": { "post": { "tags": [ "Groups" ], "operationId": "postGroupssetTopic", "description": "The parameters and request body are for method: postGroupssetTopic. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "topic": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "topic": "topic", "channel": "channel" } } } } } }, "/groups.unarchive": { "post": { "tags": [ "Groups" ], "operationId": "postGroupsunarchive", "description": "The parameters and request body are for method: postGroupsunarchive. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/im.close": { "post": { "tags": [ "Im" ], "operationId": "postImclose", "description": "The parameters and request body are for method: postImclose. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/im.history": { "get": { "tags": [ "Im" ], "operationId": "getImhistory", "description": "The parameters and request body are for method: getImhistory. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "latest": { "type": "string" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" } } } }, "ok": { "type": "boolean" } } }, "example": { "has_more": false, "latest": "1358547726.000003", "messages": [ { "text": "Hello", "ts": "1358546515.000008", "type": "message", "user": "U2147483896" }, { "is_starred": true, "text": "World", "ts": "1358546515.000007", "type": "message", "user": "U2147483896" }, { "ts": "1358546515.000007", "type": "something_else" } ], "ok": true } } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "unreads", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "inclusive", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "oldest", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "latest", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/im.list": { "get": { "tags": [ "Im" ], "operationId": "getImlist", "description": "The parameters and request body are for method: getImlist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ims": { "type": "array", "items": { "type": "object", "properties": { "created": { "type": "number" }, "id": { "type": "string" }, "is_im": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_user_deleted": { "type": "boolean" }, "user": { "type": "string" } } } }, "ok": { "type": "boolean" }, "response_metadata": { "type": "object", "properties": { "next_cursor": { "type": "string" } } } } }, "example": { "ims": [ { "created": 1449709280, "id": "D0G9QPY56", "is_im": true, "is_org_shared": false, "is_user_deleted": false, "user": "USLACKBOT" }, { "created": 1466692204, "id": "D1KL59A72", "is_im": true, "is_org_shared": false, "is_user_deleted": false, "user": "U0G9QF9C6" }, { "created": 1449722883, "id": "D0G9XPFH9", "is_im": true, "is_org_shared": false, "is_user_deleted": false, "user": "U0G9WFXNZ" }, { "created": 1452098023, "id": "D0HRHJSF7", "is_im": true, "is_org_shared": false, "is_user_deleted": false, "user": "W0HRJL7CK" }, { "created": 1465834222, "id": "D1GD7CHC0", "is_im": true, "is_org_shared": false, "is_user_deleted": true, "user": "U1GDBDGR3" }, { "created": 1468274703, "id": "D1QMF76M9", "is_im": true, "is_org_shared": false, "is_user_deleted": false, "user": "U1QNSQB9U" }, { "created": 1502210225, "id": "D6K48KKRN", "is_im": true, "is_org_shared": false, "is_user_deleted": false, "user": "U6KR7BVFW" } ], "ok": true, "response_metadata": { "next_cursor": "aW1faWQ6RDBCSDk1RExI=" } } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/im.mark": { "post": { "tags": [ "Im" ], "operationId": "postImmark", "description": "The parameters and request body are for method: postImmark. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ts": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "ts": "ts", "channel": "channel" } } } } } }, "/im.open": { "post": { "tags": [ "Im" ], "operationId": "postImopen", "description": "The parameters and request body are for method: postImopen. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "id": { "type": "string" } } }, "ok": { "type": "boolean" } } }, "example": { "channel": { "id": "D947RLWRX" }, "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "returnIm": { "type": "string" }, "user": { "type": "string" }, "includeLocale": { "type": "string" } } }, "example": { "returnIm": "returnIm", "user": "user", "includeLocale": "includeLocale" } } } } } }, "/im.replies": { "get": { "tags": [ "Im" ], "operationId": "getImreplies", "description": "The parameters and request body are for method: getImreplies. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" } } } }, "ok": { "type": "boolean" } } }, "example": { "messages": [ { "text": "Hello", "ts": "1358546515.000008", "type": "message", "user": "U2147483896" }, { "is_starred": true, "text": "World", "ts": "1358546515.000007", "type": "message", "user": "U2147483896" }, { "ts": "1358546515.000007", "type": "something_else" } ], "ok": true } } } } }, "parameters": [ { "name": "threadTs", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/migration.exchange": { "get": { "tags": [ "Migration" ], "operationId": "getMigrationexchange", "description": "The parameters and request body are for method: getMigrationexchange. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "enterprise_id": { "type": "string" }, "invalid_user_ids": { "type": "array", "items": { "type": "string" } }, "ok": { "type": "boolean" }, "team_id": { "type": "string" }, "user_id_map": { "type": "object", "properties": { "U06UBSUN5": { "type": "string" }, "U06UBSVB3": { "type": "string" }, "U06UBSVDX": { "type": "string" }, "U06UEB62U": { "type": "string" }, "W06UAZ65Q": { "type": "string" } } } } }, "example": { "enterprise_id": "E1KQTNXE1", "invalid_user_ids": [ "U21ABZZXX" ], "ok": true, "team_id": "T1KR7PE1W", "user_id_map": { "U06UBSUN5": "W06M56XJM", "U06UBSVB3": "W06PUUDLY", "U06UBSVDX": "W06PUUDMW", "U06UEB62U": "W06PTT6GH", "W06UAZ65Q": "W06UAZ65Q" } } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toOld", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "users", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/mpim.close": { "post": { "tags": [ "Mpim" ], "operationId": "postMpimclose", "description": "The parameters and request body are for method: postMpimclose. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string" } } }, "example": { "channel": "channel" } } } } } }, "/mpim.history": { "get": { "tags": [ "Mpim" ], "operationId": "getMpimhistory", "description": "The parameters and request body are for method: getMpimhistory. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "latest": { "type": "string" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" } } } }, "ok": { "type": "boolean" } } }, "example": { "has_more": false, "latest": "1358547726.000003", "messages": [ { "text": "Hello", "ts": "1358546515.000008", "type": "message", "user": "U2147483896" }, { "is_starred": true, "text": "World", "ts": "1358546515.000007", "type": "message", "user": "U2147483896" }, { "ts": "1358546515.000007", "type": "something_else" } ], "ok": true } } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "unreads", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "inclusive", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "oldest", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "latest", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/mpim.list": { "get": { "tags": [ "Mpim" ], "operationId": "getMpimlist", "description": "The parameters and request body are for method: getMpimlist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/mpim.mark": { "post": { "tags": [ "Mpim" ], "operationId": "postMpimmark", "description": "The parameters and request body are for method: postMpimmark. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ts": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "ts": "ts", "channel": "channel" } } } } } }, "/mpim.open": { "post": { "tags": [ "Mpim" ], "operationId": "postMpimopen", "description": "The parameters and request body are for method: postMpimopen. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "id": { "type": "string" } } }, "ok": { "type": "boolean" } } }, "example": { "channel": { "id": "D024BFF1M" }, "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "users": { "type": "string" } } }, "example": { "users": "users" } } } } } }, "/mpim.replies": { "get": { "tags": [ "Mpim" ], "operationId": "getMpimreplies", "description": "The parameters and request body are for method: getMpimreplies. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" } } } }, "ok": { "type": "boolean" } } }, "example": { "messages": [ { "text": "Hello", "ts": "1358546515.000008", "type": "message", "user": "U2147483896" }, { "is_starred": true, "text": "World", "ts": "1358546515.000007", "type": "message", "user": "U2147483896" }, { "ts": "1358546515.000007", "type": "something_else" } ], "ok": true } } } } }, "parameters": [ { "name": "threadTs", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/oauth.access": { "get": { "tags": [ "Oauth" ], "operationId": "getOauthaccess", "description": "The parameters and request body are for method: getOauthaccess. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "scope": { "type": "string" }, "team_id": { "type": "string" }, "team_name": { "type": "string" } } }, "example": { "access_token": "xoxp-XXXXXXXX-XXXXXXXX-XXXXX", "scope": "groups:write", "team_id": "TXXXXXXXXX", "team_name": "Wyld Stallyns LLC" } } } } }, "parameters": [ { "name": "clientSecret", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "singleChannel", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "clientId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "redirectUri", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/oauth.token": { "get": { "tags": [ "Oauth" ], "operationId": "getOauthtoken", "description": "The parameters and request body are for method: getOauthtoken. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "app_id": { "type": "string" }, "app_user_id": { "type": "string" }, "authorizing_user_id": { "type": "string" }, "installer_user_id": { "type": "string" }, "ok": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "resource_id": { "type": "number" }, "resource_type": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } } } }, "single_channel_id": { "type": "string" }, "team_id": { "type": "string" }, "team_name": { "type": "string" }, "token_type": { "type": "string" } } }, "example": { "access_token": "xoxa-access-token-string", "app_id": "A012345678", "app_user_id": "U0AB12ABC", "authorizing_user_id": "U0HTT3Q0G", "installer_user_id": "U061F7AUR", "ok": true, "permissions": [ { "resource_id": 0, "resource_type": "channel", "scopes": [ "channels:read", "chat:write:user" ] } ], "single_channel_id": "C061EG9T2", "team_id": "T061EG9Z9", "team_name": "Subarachnoid Workspace", "token_type": "app" } } } } }, "parameters": [ { "name": "clientSecret", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "singleChannel", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "clientId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "redirectUri", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pins.add": { "post": { "tags": [ "Pins" ], "operationId": "postPinsadd", "description": "The parameters and request body are for method: postPinsadd. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileComment": { "type": "string" }, "timestamp": { "type": "string" }, "file": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "fileComment": "fileComment", "timestamp": "timestamp", "file": "file", "channel": "channel" } } } } } }, "/pins.list": { "get": { "tags": [ "Pins" ], "operationId": "getPinslist", "description": "The parameters and request body are for method: getPinslist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "string" }, "created": { "type": "number" }, "created_by": { "type": "string" }, "message": { "type": "object", "properties": { "permalink": { "type": "string" }, "pinned_to": { "type": "array", "items": { "type": "string" } }, "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" } } }, "type": { "type": "string" } } } }, "ok": { "type": "boolean" } } }, "example": { "items": [ { "channel": "C2U86NC6H", "created": 1508881078, "created_by": "U2U85N1RZ", "message": { "permalink": "https://hitchhikers.slack.com/archives/C2U86NC6H/p1508197641000151", "pinned_to": [ "C2U86NC6H" ], "text": "What is the meaning of life?", "ts": "1508197641.000151", "type": "message", "user": "U2U85N1RZ" }, "type": "message" }, { "channel": "C2U86NC6H", "created": 1508880991, "created_by": "U2U85N1RZ", "message": { "permalink": "https://hitchhikers.slack.com/archives/C2U86NC6H/p1508284197000015", "pinned_to": [ "C2U86NC6H" ], "text": "The meaning of life, the universe, and everything is 42.", "ts": "1503289197.000015", "type": "message", "user": "U2U85N1RZ" }, "type": "message" } ], "ok": true } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pins.remove": { "post": { "tags": [ "Pins" ], "operationId": "postPinsremove", "description": "The parameters and request body are for method: postPinsremove. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileComment": { "type": "string" }, "timestamp": { "type": "string" }, "file": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "fileComment": "fileComment", "timestamp": "timestamp", "file": "file", "channel": "channel" } } } } } }, "/reactions.add": { "post": { "tags": [ "Reactions" ], "operationId": "postReactionsadd", "description": "The parameters and request body are for method: postReactionsadd. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "fileComment": { "type": "string" }, "timestamp": { "type": "string" }, "file": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "name": "name", "fileComment": "fileComment", "timestamp": "timestamp", "file": "file", "channel": "channel" } } } } } }, "/reactions.get": { "get": { "tags": [ "Reactions" ], "operationId": "getReactionsget", "description": "The parameters and request body are for method: getReactionsget. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "string" } }, "comments_count": { "type": "number" }, "created": { "type": "number" }, "groups": { "type": "object" }, "id": { "type": "string" }, "ims": { "type": "object" }, "name": { "type": "string" }, "reactions": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "number" }, "name": { "type": "string" }, "users": { "type": "array", "items": { "type": "string" } } } } }, "timestamp": { "type": "number" }, "title": { "type": "string" }, "user": { "type": "string" } } }, "ok": { "type": "boolean" }, "type": { "type": "string" } } }, "example": { "file": { "channels": [ "C2U7V2YA2" ], "comments_count": 1, "created": 1507850315, "groups": [], "id": "F7H0D7ZA4", "ims": [], "name": "computer.gif", "reactions": [ { "count": 1, "name": "stuck_out_tongue_winking_eye", "users": [ "U2U85N1RV" ] } ], "timestamp": 1507850315, "title": "computer.gif", "user": "U2U85N1RV" }, "ok": true, "type": "file" } } } } }, "parameters": [ { "name": "full", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "fileComment", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "timestamp", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "file", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/reactions.list": { "get": { "tags": [ "Reactions" ], "operationId": "getReactionslist", "description": "The parameters and request body are for method: getReactionslist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "string" }, "message": { "type": "object", "properties": { "bot_id": { "type": "string" }, "reactions": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "number" }, "name": { "type": "string" }, "users": { "type": "array", "items": { "type": "string" } } } } }, "subtype": { "type": "string" }, "text": { "type": "string" }, "ts": { "type": "string" }, "username": { "type": "string" } } }, "type": { "type": "string" } } } }, "ok": { "type": "boolean" }, "paging": { "type": "object", "properties": { "count": { "type": "number" }, "page": { "type": "number" }, "pages": { "type": "number" }, "total": { "type": "number" } } } } }, "example": { "items": [ { "channel": "C3UKJTQAC", "message": { "bot_id": "B4VLRLMKJ", "reactions": [ { "count": 1, "name": "robot_face", "users": [ "U2U85N1RV" ] } ], "subtype": "bot_message", "text": "Hello from Python! :tada:", "ts": "1507849573.000090", "username": "Shipit Notifications" }, "type": "message" }, { "comment": { "comment": "This is a file comment", "created": 1508286096, "id": "Fc7LP08P1U", "reactions": [ { "count": 1, "name": "white_check_mark", "users": [ "U2U85N1RV" ] } ], "timestamp": 1508286096, "type": "file_comment", "user": "U2U85N1RV" }, "file": { "channels": [ "C2U7V2YA2" ], "comments_count": 1, "created": 1507850315, "reactions": [ { "count": 1, "name": "stuck_out_tongue_winking_eye", "users": [ "U2U85N1RV" ] } ], "title": "computer.gif", "user": "U2U85N1RV", "username": "" } }, { "file": { "channels": [ "C2U7V2YA2" ], "comments_count": 1, "created": 1507850315, "id": "F7H0D7ZA4", "name": "computer.gif", "reactions": [ { "count": 1, "name": "stuck_out_tongue_winking_eye", "users": [ "U2U85N1RV" ] } ], "size": 1639034, "title": "computer.gif", "user": "U2U85N1RV", "username": "" }, "type": "file" } ], "ok": true, "paging": { "count": 100, "page": 1, "pages": 1, "total": 3 } } } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "full", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/reactions.remove": { "post": { "tags": [ "Reactions" ], "operationId": "postReactionsremove", "description": "The parameters and request body are for method: postReactionsremove. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "fileComment": { "type": "string" }, "timestamp": { "type": "string" }, "file": { "type": "string" }, "channel": { "type": "string" } } }, "example": { "name": "name", "fileComment": "fileComment", "timestamp": "timestamp", "file": "file", "channel": "channel" } } } } } }, "/reminders.add": { "post": { "tags": [ "Reminders" ], "operationId": "postRemindersadd", "description": "The parameters and request body are for method: postRemindersadd. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string" }, "user": { "type": "string" }, "time": { "type": "string" } } }, "example": { "text": "text", "user": "user", "time": "time" } } } } } }, "/reminders.complete": { "post": { "tags": [ "Reminders" ], "operationId": "postReminderscomplete", "description": "The parameters and request body are for method: postReminderscomplete. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reminder": { "type": "string" } } }, "example": { "reminder": "reminder" } } } } } }, "/reminders.delete": { "post": { "tags": [ "Reminders" ], "operationId": "postRemindersdelete", "description": "The parameters and request body are for method: postRemindersdelete. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reminder": { "type": "string" } } }, "example": { "reminder": "reminder" } } } } } }, "/reminders.info": { "get": { "tags": [ "Reminders" ], "operationId": "getRemindersinfo", "description": "The parameters and request body are for method: getRemindersinfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "reminder", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/reminders.list": { "get": { "tags": [ "Reminders" ], "operationId": "getReminderslist", "description": "The parameters and request body are for method: getReminderslist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/rtm.connect": { "get": { "tags": [ "Rtm" ], "operationId": "getRtmconnect", "description": "The parameters and request body are for method: getRtmconnect. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "self": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "team": { "type": "object", "properties": { "domain": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "url": { "type": "string" } } }, "example": { "ok": true, "self": { "id": "U4X318ZMZ", "name": "robotoverlord" }, "team": { "domain": "slackdemo", "id": "T2U81E2FP", "name": "SlackDemo" }, "url": "wss://..." } } } } }, "parameters": [ { "name": "presenceSub", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "batchPresenceAware", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/rtm.start": { "get": { "tags": [ "Rtm" ], "operationId": "getRtmstart", "description": "The parameters and request body are for method: getRtmstart. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "noLatest", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "simpleLatest", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeLocale", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "presenceSub", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "noUnreads", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "batchPresenceAware", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "mpimAware", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/search.all": { "get": { "tags": [ "Search" ], "operationId": "getSearchall", "description": "The parameters and request body are for method: getSearchall. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "files": { "type": "object", "properties": { "matches": { "type": "array", "items": { "type": "object", "properties": { "channels": { "type": "object" }, "comments_count": { "type": "number" }, "created": { "type": "number" }, "display_as_bot": { "type": "boolean" }, "editable": { "type": "boolean" }, "external_type": { "type": "string" }, "filetype": { "type": "string" }, "groups": { "type": "object" }, "id": { "type": "string" }, "image_exif_rotation": { "type": "number" }, "ims": { "type": "object" }, "initial_comment": { "type": "object", "properties": { "comment": { "type": "string" }, "created": { "type": "number" }, "id": { "type": "string" }, "is_intro": { "type": "boolean" }, "timestamp": { "type": "number" }, "user": { "type": "string" } } }, "is_external": { "type": "boolean" }, "is_public": { "type": "boolean" }, "mimetype": { "type": "string" }, "mode": { "type": "string" }, "name": { "type": "string" }, "original_h": { "type": "number" }, "original_w": { "type": "number" }, "permalink": { "type": "string" }, "permalink_public": { "type": "string" }, "pretty_type": { "type": "string" }, "preview": { "type": "object" }, "public_url_shared": { "type": "boolean" }, "score": { "type": "string" }, "size": { "type": "number" }, "thumb_160": { "type": "string" }, "thumb_360": { "type": "string" }, "thumb_360_h": { "type": "number" }, "thumb_360_w": { "type": "number" }, "thumb_64": { "type": "string" }, "thumb_80": { "type": "string" }, "timestamp": { "type": "number" }, "title": { "type": "string" }, "top_file": { "type": "boolean" }, "url_private": { "type": "string" }, "url_private_download": { "type": "string" }, "user": { "type": "string" }, "username": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "first": { "type": "number" }, "last": { "type": "number" }, "page": { "type": "number" }, "page_count": { "type": "number" }, "per_page": { "type": "number" }, "total_count": { "type": "number" } } }, "paging": { "type": "object", "properties": { "count": { "type": "number" }, "page": { "type": "number" }, "pages": { "type": "number" }, "total": { "type": "number" } } }, "total": { "type": "number" } } }, "messages": { "type": "object", "properties": { "matches": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "id": { "type": "string" }, "is_ext_shared": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_pending_ext_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "name": { "type": "string" }, "pending_shared": { "type": "object" } } }, "iid": { "type": "string" }, "next": { "type": "object", "properties": { "iid": { "type": "string" }, "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" }, "username": { "type": "string" } } }, "permalink": { "type": "string" }, "previous": { "type": "object", "properties": { "iid": { "type": "string" }, "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" }, "username": { "type": "string" } } }, "team": { "type": "string" }, "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" }, "username": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "first": { "type": "number" }, "last": { "type": "number" }, "page": { "type": "number" }, "page_count": { "type": "number" }, "per_page": { "type": "number" }, "total_count": { "type": "number" } } }, "paging": { "type": "object", "properties": { "count": { "type": "number" }, "page": { "type": "number" }, "pages": { "type": "number" }, "total": { "type": "number" } } }, "total": { "type": "number" } } }, "ok": { "type": "boolean" }, "posts": { "type": "object", "properties": { "matches": { "type": "object" }, "total": { "type": "number" } } }, "query": { "type": "string" } } }, "example": { "files": { "matches": [ { "channels": [], "comments_count": 1, "created": 1508804330, "display_as_bot": false, "editable": false, "external_type": "", "filetype": "png", "groups": [], "id": "F7PKF1NR7", "image_exif_rotation": 1, "ims": [], "initial_comment": { "comment": "Sure! Here's the workflow diagram!", "created": 1508804330, "id": "Fc7NLL52E7", "is_intro": true, "timestamp": 1508804330, "user": "U2U85N1RZ" }, "is_external": false, "is_public": true, "mimetype": "image/png", "mode": "hosted", "name": "slack workflow diagram.png", "original_h": 117, "original_w": 128, "permalink": "https://example.slack.com/files/U2U85N1RZ/F7PKF1NR7/slack_workflow_diagram.png", "permalink_public": "https://slack-files.com/T2U81E2FZ-F7PKF1NR7-bea9143f18", "pretty_type": "PNG", "preview": null, "public_url_shared": false, "score": "0.99982661240974", "size": 35705, "thumb_160": "https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_160.png", "thumb_360": "https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_360.png", "thumb_360_h": 117, "thumb_360_w": 128, "thumb_64": "https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_64.png", "thumb_80": "https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_80.png", "timestamp": 1508804330, "title": "slack workflow diagram", "top_file": false, "url_private": "https://files.slack.com/files-pri/T2U81E2FZ-F7PKF1NR7/slack_workflow_diagram.png", "url_private_download": "https://files.slack.com/files-pri/T2U81E2FZ-F7PKF1NR7/download/slack_workflow_diagram.png", "user": "U2U85N1RZ", "username": "amy" } ], "pagination": { "first": 1, "last": 1, "page": 1, "page_count": 1, "per_page": 20, "total_count": 1 }, "paging": { "count": 20, "page": 1, "pages": 1, "total": 1 }, "total": 1 }, "messages": { "matches": [ { "channel": { "id": "C2U86NC6M", "is_ext_shared": false, "is_mpim": false, "is_org_shared": false, "is_pending_ext_shared": false, "is_private": false, "is_shared": false, "name": "general", "pending_shared": [] }, "iid": "35692677-e60e-43d9-ac45-1987cea88975", "next": { "iid": "6f510ea1-e1d3-4f3f-bdb9-f9c6f6e9d609", "text": "Thanks!", "ts": "1508804378.000219", "type": "message", "user": "U2U85HJ7R", "username": "john" }, "permalink": "https://example.slack.com/archives/C2U86NC6M/p1508804330000296", "previous": { "iid": "aba8603c-0543-4fb2-9118-a5ac85f3d138", "text": "Can you send me the Slack workflow diagram?", "ts": "1508804301.000026", "type": "message", "user": "U2U85HJ7R", "username": "john" }, "team": "T2U81E2FZ", "text": "uploaded a file: and commented: Sure! Here's the workflow diagram!", "ts": "1508804330.000296", "type": "message", "user": "U2U85N1RZ", "username": "amy" } ], "pagination": { "first": 1, "last": 1, "page": 1, "page_count": 1, "per_page": 20, "total_count": 1 }, "paging": { "count": 20, "page": 1, "pages": 1, "total": 1 }, "total": 1 }, "ok": true, "posts": { "matches": [], "total": 0 }, "query": "diagram" } } } } }, "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "object" } }, { "name": "sortDir", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "highlight", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/search.files": { "get": { "tags": [ "Search" ], "operationId": "getSearchfiles", "description": "The parameters and request body are for method: getSearchfiles. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "files": { "type": "object", "properties": { "matches": { "type": "array", "items": { "type": "object", "properties": { "channels": { "type": "object" }, "comments_count": { "type": "number" }, "created": { "type": "number" }, "deanimate_gif": { "type": "string" }, "display_as_bot": { "type": "boolean" }, "editable": { "type": "boolean" }, "external_type": { "type": "string" }, "filetype": { "type": "string" }, "groups": { "type": "object" }, "id": { "type": "string" }, "image_exif_rotation": { "type": "number" }, "ims": { "type": "object" }, "is_external": { "type": "boolean" }, "is_public": { "type": "boolean" }, "mimetype": { "type": "string" }, "mode": { "type": "string" }, "name": { "type": "string" }, "original_h": { "type": "number" }, "original_w": { "type": "number" }, "permalink": { "type": "string" }, "permalink_public": { "type": "string" }, "pretty_type": { "type": "string" }, "preview": { "type": "object" }, "public_url_shared": { "type": "boolean" }, "reactions": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "number" }, "name": { "type": "string" }, "users": { "type": "array", "items": { "type": "string" } } } } }, "score": { "type": "string" }, "size": { "type": "number" }, "thumb_160": { "type": "string" }, "thumb_360": { "type": "string" }, "thumb_360_gif": { "type": "string" }, "thumb_360_h": { "type": "number" }, "thumb_360_w": { "type": "number" }, "thumb_480": { "type": "string" }, "thumb_480_gif": { "type": "string" }, "thumb_480_h": { "type": "number" }, "thumb_480_w": { "type": "number" }, "thumb_64": { "type": "string" }, "thumb_80": { "type": "string" }, "timestamp": { "type": "number" }, "title": { "type": "string" }, "top_file": { "type": "boolean" }, "url_private": { "type": "string" }, "url_private_download": { "type": "string" }, "user": { "type": "string" }, "username": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "first": { "type": "number" }, "last": { "type": "number" }, "page": { "type": "number" }, "page_count": { "type": "number" }, "per_page": { "type": "number" }, "total_count": { "type": "number" } } }, "paging": { "type": "object", "properties": { "count": { "type": "number" }, "page": { "type": "number" }, "pages": { "type": "number" }, "total": { "type": "number" } } }, "total": { "type": "number" } } }, "ok": { "type": "boolean" }, "query": { "type": "string" } } }, "example": { "files": { "matches": [ { "channels": [], "comments_count": 1, "created": 1507850315, "deanimate_gif": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_deanimate_gif.png", "display_as_bot": false, "editable": false, "external_type": "", "filetype": "gif", "groups": [], "id": "F7H0D7ZBB", "image_exif_rotation": 1, "ims": [], "is_external": false, "is_public": true, "mimetype": "image/gif", "mode": "hosted", "name": "computer.gif", "original_h": 313, "original_w": 500, "permalink": "https://eventsdemo.slack.com/files/U2U85N1RZ/F7H0D7ZBB/computer.gif", "permalink_public": "https://slack-files.com/T2U81E2BB-F7H0D7ZBB-85b7f5557e", "pretty_type": "GIF", "preview": null, "public_url_shared": false, "reactions": [ { "count": 1, "name": "stuck_out_tongue_winking_eye", "users": [ "U2U85N1RZ" ] } ], "score": "0.38899223746309", "size": 1639034, "thumb_160": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_160.png", "thumb_360": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_360.png", "thumb_360_gif": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_360.gif", "thumb_360_h": 225, "thumb_360_w": 360, "thumb_480": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_480.png", "thumb_480_gif": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_480.gif", "thumb_480_h": 300, "thumb_480_w": 480, "thumb_64": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_64.png", "thumb_80": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_80.png", "timestamp": 1507850315, "title": "computer.gif", "top_file": false, "url_private": "https://files.slack.com/files-pri/T2U81E2BB-F7H0D7ZBB/computer.gif", "url_private_download": "https://files.slack.com/files-pri/T2U81E2BB-F7H0D7ZBB/download/computer.gif", "user": "U2U85N1RZ", "username": "" } ], "pagination": { "first": 1, "last": 3, "page": 1, "page_count": 1, "per_page": 20, "total_count": 3 }, "paging": { "count": 20, "page": 1, "pages": 1, "total": 3 }, "total": 3 }, "ok": true, "query": "computer.gif" } } } } }, "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "object" } }, { "name": "sortDir", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "highlight", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/search.messages": { "get": { "tags": [ "Search" ], "operationId": "getSearchmessages", "description": "The parameters and request body are for method: getSearchmessages. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "messages": { "type": "object", "properties": { "matches": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "id": { "type": "string" }, "is_ext_shared": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_pending_ext_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "name": { "type": "string" }, "pending_shared": { "type": "object" } } }, "iid": { "type": "string" }, "permalink": { "type": "string" }, "team": { "type": "string" }, "text": { "type": "string" }, "ts": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" }, "username": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "first": { "type": "number" }, "last": { "type": "number" }, "page": { "type": "number" }, "page_count": { "type": "number" }, "per_page": { "type": "number" }, "total_count": { "type": "number" } } }, "paging": { "type": "object", "properties": { "count": { "type": "number" }, "page": { "type": "number" }, "pages": { "type": "number" }, "total": { "type": "number" } } }, "total": { "type": "number" } } }, "ok": { "type": "boolean" }, "query": { "type": "string" } } }, "example": { "messages": { "matches": [ { "channel": { "id": "C12345678", "is_ext_shared": false, "is_mpim": false, "is_org_shared": false, "is_pending_ext_shared": false, "is_private": false, "is_shared": false, "name": "general", "pending_shared": [] }, "iid": "cb64bdaa-c1e8-4631-8a91-0f78080113e9", "permalink": "https://hitchhikers.slack.com/archives/C12345678/p1508284197000015", "team": "T12345678", "text": "The meaning of life the universe and everything is 42.", "ts": "1508284197.000015", "type": "message", "user": "U2U85N1RV", "username": "roach" }, { "channel": { "id": "C12345678", "is_ext_shared": false, "is_mpim": false, "is_org_shared": false, "is_pending_ext_shared": false, "is_private": false, "is_shared": false, "name": "random", "pending_shared": [] }, "iid": "9a00d3c9-bd2d-45b0-988b-6cff99ae2a90", "permalink": "https://hitchhikers.slack.com/archives/C12345678/p1508795665000236", "team": "T12345678", "text": "The meaning of life the universe and everything is 101010", "ts": "1508795665.000236", "type": "message", "user": "", "username": "robot overlord" } ], "pagination": { "first": 1, "last": 2, "page": 1, "page_count": 1, "per_page": 20, "total_count": 2 }, "paging": { "count": 20, "page": 1, "pages": 1, "total": 2 }, "total": 2 }, "ok": true, "query": "The meaning of life the universe and everything" } } } } }, "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "object" } }, { "name": "sortDir", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "highlight", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/stars.add": { "post": { "tags": [ "Stars" ], "operationId": "postStarsadd", "description": "The parameters and request body are for method: postStarsadd. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileComment": { "type": "string" }, "timestamp": { "type": "string" }, "channel": { "type": "string" }, "file": { "type": "string" } } }, "example": { "fileComment": "fileComment", "timestamp": "timestamp", "channel": "channel", "file": "file" } } } } } }, "/stars.list": { "get": { "tags": [ "Stars" ], "operationId": "getStarslist", "description": "The parameters and request body are for method: getStarslist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/stars.remove": { "post": { "tags": [ "Stars" ], "operationId": "postStarsremove", "description": "The parameters and request body are for method: postStarsremove. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileComment": { "type": "string" }, "timestamp": { "type": "string" }, "channel": { "type": "string" }, "file": { "type": "string" } } }, "example": { "fileComment": "fileComment", "timestamp": "timestamp", "channel": "channel", "file": "file" } } } } } }, "/team.accessLogs": { "get": { "tags": [ "Team" ], "operationId": "getTeamaccessLogs", "description": "The parameters and request body are for method: getTeamaccessLogs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "before", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/team.billableInfo": { "get": { "tags": [ "Team" ], "operationId": "getTeambillableInfo", "description": "The parameters and request body are for method: getTeambillableInfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/team.info": { "get": { "tags": [ "Team" ], "operationId": "getTeaminfo", "description": "The parameters and request body are for method: getTeaminfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "team": { "type": "object", "properties": { "domain": { "type": "string" }, "email_domain": { "type": "string" }, "enterprise_id": { "type": "string" }, "enterprise_name": { "type": "string" }, "icon": { "type": "object", "properties": { "image_102": { "type": "string" }, "image_132": { "type": "string" }, "image_34": { "type": "string" }, "image_44": { "type": "string" }, "image_68": { "type": "string" }, "image_88": { "type": "string" }, "image_default": { "type": "boolean" } } }, "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "ok": true, "team": { "domain": "example", "email_domain": "example.com", "enterprise_id": "E1234A12AB", "enterprise_name": "Umbrella Corporation", "icon": { "image_102": "https://...", "image_132": "https://...", "image_34": "https://...", "image_44": "https://...", "image_68": "https://...", "image_88": "https://...", "image_default": true }, "id": "T12345", "name": "My Team" } } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/team.integrationLogs": { "get": { "tags": [ "Team" ], "operationId": "getTeamintegrationLogs", "description": "The parameters and request body are for method: getTeamintegrationLogs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "changeType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "appId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serviceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/team.profile.get": { "get": { "tags": [ "Teamprofile" ], "operationId": "getTeamprofileget", "description": "The parameters and request body are for method: getTeamprofileget. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "profile": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "hint": { "type": "string" }, "id": { "type": "string" }, "is_hidden": { "type": "number" }, "label": { "type": "string" }, "options": { "type": "object" }, "ordering": { "type": "number" }, "possible_values": { "type": "object" }, "type": { "type": "string" } } } } } } } }, "example": { "ok": true, "profile": { "fields": [ { "hint": "Enter the extension to reach your desk", "id": "Xf06054AAA", "is_hidden": 1, "label": "Phone extension", "options": null, "ordering": 0, "possible_values": null, "type": "text" }, { "hint": "When you were born", "id": "Xf06054BBB", "label": "Date of birth", "options": null, "ordering": 1, "possible_values": null, "type": "date" }, { "hint": "Enter a link to your Facebook profile", "id": "Xf06054CCC", "label": "Facebook", "options": null, "ordering": 2, "possible_values": null, "type": "link" }, { "hint": "Hogwarts, obviously", "id": "Xf06054DDD", "label": "House", "options": null, "ordering": 3, "possible_values": [ "Gryffindor", "Hufflepuff", "Ravenclaw", "Slytherin" ], "type": "options_list" }, { "hint": "Office location (LDAP)", "id": "Xf06054EEE", "label": "Location", "options": { "is_protected": 1 }, "ordering": 4, "possible_values": null, "type": "text" }, { "hint": "The boss", "id": "Xf06054FFF", "label": "Manager", "options": null, "ordering": 5, "possible_values": null, "type": "user" } ] } } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "visibility", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/usergroups.create": { "post": { "tags": [ "Usergroups" ], "operationId": "postUsergroupscreate", "description": "The parameters and request body are for method: postUsergroupscreate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "handle": { "type": "string" }, "name": { "type": "string" }, "channels": { "type": "string" }, "includeCount": { "type": "string" }, "description": { "type": "string" } } }, "example": { "handle": "handle", "name": "name", "channels": "channels", "includeCount": "includeCount", "description": "description" } } } } } }, "/usergroups.disable": { "post": { "tags": [ "Usergroups" ], "operationId": "postUsergroupsdisable", "description": "The parameters and request body are for method: postUsergroupsdisable. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "includeCount": { "type": "string" }, "usergroup": { "type": "string" } } }, "example": { "includeCount": "includeCount", "usergroup": "usergroup" } } } } } }, "/usergroups.enable": { "post": { "tags": [ "Usergroups" ], "operationId": "postUsergroupsenable", "description": "The parameters and request body are for method: postUsergroupsenable. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "includeCount": { "type": "string" }, "usergroup": { "type": "string" } } }, "example": { "includeCount": "includeCount", "usergroup": "usergroup" } } } } } }, "/usergroups.list": { "get": { "tags": [ "Usergroups" ], "operationId": "getUsergroupslist", "description": "The parameters and request body are for method: getUsergroupslist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "usergroups": { "type": "array", "items": { "type": "object", "properties": { "auto_type": { "type": "string" }, "created_by": { "type": "string" }, "date_create": { "type": "number" }, "date_delete": { "type": "number" }, "date_update": { "type": "number" }, "deleted_by": { "type": "object" }, "description": { "type": "string" }, "handle": { "type": "string" }, "id": { "type": "string" }, "is_external": { "type": "boolean" }, "is_usergroup": { "type": "boolean" }, "name": { "type": "string" }, "prefs": { "type": "object", "properties": { "channels": { "type": "object" }, "groups": { "type": "object" } } }, "team_id": { "type": "string" }, "updated_by": { "type": "string" }, "user_count": { "type": "string" } } } } } }, "example": { "ok": true, "usergroups": [ { "auto_type": "admin", "created_by": "USLACKBOT", "date_create": 1446598059, "date_delete": 0, "date_update": 1446670362, "deleted_by": null, "description": "A group of all Administrators on your team.", "handle": "admins", "id": "S0614TZR7", "is_external": false, "is_usergroup": true, "name": "Team Admins", "prefs": { "channels": [], "groups": [] }, "team_id": "T060RNRCH", "updated_by": "U060RNRCZ", "user_count": "2" }, { "auto_type": "owner", "created_by": "USLACKBOT", "date_create": 1446678371, "date_delete": 0, "date_update": 1446678371, "deleted_by": null, "description": "A group of all Owners on your team.", "handle": "owners", "id": "S06158AV7", "is_external": false, "is_usergroup": true, "name": "Team Owners", "prefs": { "channels": [], "groups": [] }, "team_id": "T060RNRCH", "updated_by": "USLACKBOT", "user_count": "1" }, { "auto_type": null, "created_by": "U060RNRCZ", "date_create": 1446746793, "date_delete": 1446748865, "date_update": 1446747767, "deleted_by": null, "description": "Marketing gurus, PR experts and product advocates.", "handle": "marketing-team", "id": "S0615G0KT", "is_external": false, "is_usergroup": true, "name": "Marketing Team", "prefs": { "channels": [], "groups": [] }, "team_id": "T060RNRCH", "updated_by": "U060RNRCZ", "user_count": "0" } ] } } } } }, "parameters": [ { "name": "includeUsers", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeCount", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeDisabled", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/usergroups.update": { "post": { "tags": [ "Usergroups" ], "operationId": "postUsergroupsupdate", "description": "The parameters and request body are for method: postUsergroupsupdate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "usergroup": { "type": "object", "properties": { "auto_type": { "type": "object" }, "created_by": { "type": "string" }, "date_create": { "type": "number" }, "date_delete": { "type": "number" }, "date_update": { "type": "number" }, "deleted_by": { "type": "object" }, "description": { "type": "string" }, "handle": { "type": "string" }, "id": { "type": "string" }, "is_external": { "type": "boolean" }, "is_usergroup": { "type": "boolean" }, "name": { "type": "string" }, "prefs": { "type": "object", "properties": { "channels": { "type": "object" }, "groups": { "type": "object" } } }, "team_id": { "type": "string" }, "updated_by": { "type": "string" }, "user_count": { "type": "number" }, "users": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "ok": true, "usergroup": { "auto_type": null, "created_by": "U060R4BJ4", "date_create": 1447096577, "date_delete": 0, "date_update": 1447102109, "deleted_by": null, "description": "Marketing gurus, PR experts and product advocates.", "handle": "marketing-team", "id": "S0616NG6M", "is_external": false, "is_usergroup": true, "name": "Marketing Team", "prefs": { "channels": [], "groups": [] }, "team_id": "T060R4BHN", "updated_by": "U060R4BJ4", "user_count": 1, "users": [ "U060R4BJ4", "U060RNRCZ" ] } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "handle": { "type": "string" }, "description": { "type": "string" }, "channels": { "type": "string" }, "includeCount": { "type": "string" }, "usergroup": { "type": "string" }, "name": { "type": "string" } } }, "example": { "handle": "handle", "description": "description", "channels": "channels", "includeCount": "includeCount", "usergroup": "usergroup", "name": "name" } } } } } }, "/usergroups.users.list": { "get": { "tags": [ "Usergroupsusers" ], "operationId": "getUsergroupsuserslist", "description": "The parameters and request body are for method: getUsergroupsuserslist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "users": { "type": "array", "items": { "type": "string" } } } }, "example": { "ok": true, "users": [ "U060R4BJ4", "W123A4BC5" ] } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeDisabled", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "usergroup", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/usergroups.users.update": { "post": { "tags": [ "Usergroupsusers" ], "operationId": "postUsergroupsusersupdate", "description": "The parameters and request body are for method: postUsergroupsusersupdate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "usergroup": { "type": "object", "properties": { "auto_type": { "type": "object" }, "created_by": { "type": "string" }, "date_create": { "type": "number" }, "date_delete": { "type": "number" }, "date_update": { "type": "number" }, "deleted_by": { "type": "object" }, "description": { "type": "string" }, "handle": { "type": "string" }, "id": { "type": "string" }, "is_external": { "type": "boolean" }, "is_usergroup": { "type": "boolean" }, "name": { "type": "string" }, "prefs": { "type": "object", "properties": { "channels": { "type": "object" }, "groups": { "type": "object" } } }, "team_id": { "type": "string" }, "updated_by": { "type": "string" }, "user_count": { "type": "number" }, "users": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "ok": true, "usergroup": { "auto_type": null, "created_by": "U060R4BJ4", "date_create": 1447096577, "date_delete": 0, "date_update": 1447102109, "deleted_by": null, "description": "Marketing gurus, PR experts and product advocates.", "handle": "marketing-team", "id": "S0616NG6M", "is_external": false, "is_usergroup": true, "name": "Marketing Team", "prefs": { "channels": [], "groups": [] }, "team_id": "T060R4BHN", "updated_by": "U060R4BJ4", "user_count": 1, "users": [ "U060R4BJ4", "U060RNRCZ" ] } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "includeCount": { "type": "string" }, "users": { "type": "string" }, "usergroup": { "type": "string" } } }, "example": { "includeCount": "includeCount", "users": "users", "usergroup": "usergroup" } } } } } }, "/users.conversations": { "get": { "tags": [ "Users" ], "operationId": "getUsersconversations", "description": "The parameters and request body are for method: getUsersconversations. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "object", "properties": { "created": { "type": "number" }, "creator": { "type": "string" }, "id": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_channel": { "type": "boolean" }, "is_ext_shared": { "type": "boolean" }, "is_general": { "type": "boolean" }, "is_group": { "type": "boolean" }, "is_im": { "type": "boolean" }, "is_mpim": { "type": "boolean" }, "is_org_shared": { "type": "boolean" }, "is_pending_ext_shared": { "type": "boolean" }, "is_private": { "type": "boolean" }, "is_shared": { "type": "boolean" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "pending_shared": { "type": "object" }, "previous_names": { "type": "object" }, "purpose": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "topic": { "type": "object", "properties": { "creator": { "type": "string" }, "last_set": { "type": "number" }, "value": { "type": "string" } } }, "unlinked": { "type": "number" } } } }, "ok": { "type": "boolean" }, "response_metadata": { "type": "object", "properties": { "next_cursor": { "type": "string" } } } } }, "example": { "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_mpim": false, "is_org_shared": false, "is_pending_ext_shared": false, "is_private": false, "is_shared": false, "name": "general", "name_normalized": "general", "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 }, { "created": 1449252889, "creator": "U061F7AUR", "id": "C061EG9T2", "is_archived": false, "is_channel": true, "is_ext_shared": false, "is_general": false, "is_group": false, "is_im": false, "is_mpim": false, "is_org_shared": false, "is_pending_ext_shared": false, "is_private": false, "is_shared": false, "name": "random", "name_normalized": "random", "pending_shared": [], "previous_names": [], "purpose": { "creator": "", "last_set": 0, "value": "A place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber you'd prefer to keep out of more focused work-related channels." }, "topic": { "creator": "", "last_set": 0, "value": "Non-work banter and water cooler conversation" }, "unlinked": 0 } ], "ok": true, "response_metadata": { "next_cursor": "dGVhbTpDMDYxRkE1UEI=" } } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "excludeArchived", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "types", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users.deletePhoto": { "post": { "tags": [ "Users" ], "operationId": "postUsersdeletePhoto", "description": "The parameters and request body are for method: postUsersdeletePhoto. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users.getPresence": { "get": { "tags": [ "Users" ], "operationId": "getUsersgetPresence", "description": "The parameters and request body are for method: getUsersgetPresence. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "presence": { "type": "string" } } }, "example": { "ok": true, "presence": "active" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users.identity": { "get": { "tags": [ "Users" ], "operationId": "getUsersidentity", "description": "The parameters and request body are for method: getUsersidentity. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "team": { "type": "object", "properties": { "id": { "type": "string" } } }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "ok": true, "team": { "id": "T0G9PQBBK" }, "user": { "id": "U0G9QF9C6", "name": "Sonny Whether" } } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users.info": { "get": { "tags": [ "Users" ], "operationId": "getUsersinfo", "description": "The parameters and request body are for method: getUsersinfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "user": { "type": "object", "properties": { "color": { "type": "string" }, "deleted": { "type": "boolean" }, "has_2fa": { "type": "boolean" }, "id": { "type": "string" }, "is_admin": { "type": "boolean" }, "is_app_user": { "type": "boolean" }, "is_bot": { "type": "boolean" }, "is_owner": { "type": "boolean" }, "is_primary_owner": { "type": "boolean" }, "is_restricted": { "type": "boolean" }, "is_ultra_restricted": { "type": "boolean" }, "name": { "type": "string" }, "profile": { "type": "object", "properties": { "avatar_hash": { "type": "string" }, "display_name": { "type": "string" }, "display_name_normalized": { "type": "string" }, "email": { "type": "string" }, "image_192": { "type": "string" }, "image_24": { "type": "string" }, "image_32": { "type": "string" }, "image_48": { "type": "string" }, "image_512": { "type": "string" }, "image_72": { "type": "string" }, "real_name": { "type": "string" }, "real_name_normalized": { "type": "string" }, "status_emoji": { "type": "string" }, "status_text": { "type": "string" }, "team": { "type": "string" } } }, "real_name": { "type": "string" }, "team_id": { "type": "string" }, "tz": { "type": "string" }, "tz_label": { "type": "string" }, "tz_offset": { "type": "number" }, "updated": { "type": "number" } } } } }, "example": { "ok": true, "user": { "color": "9f69e7", "deleted": false, "has_2fa": false, "id": "W012A3CDE", "is_admin": true, "is_app_user": false, "is_bot": false, "is_owner": false, "is_primary_owner": false, "is_restricted": false, "is_ultra_restricted": false, "name": "spengler", "profile": { "avatar_hash": "ge3b51ca72de", "display_name": "spengler", "display_name_normalized": "spengler", "email": "spengler@ghostbusters.example.com", "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "real_name": "Egon Spengler", "real_name_normalized": "Egon Spengler", "status_emoji": ":books:", "status_text": "Print is dead", "team": "T012AB3C4" }, "real_name": "Egon Spengler", "team_id": "T012AB3C4", "tz": "America/Los_Angeles", "tz_label": "Pacific Daylight Time", "tz_offset": -25200, "updated": 1502138686 } } } } } }, "parameters": [ { "name": "includeLocale", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users.list": { "get": { "tags": [ "Users" ], "operationId": "getUserslist", "description": "The parameters and request body are for method: getUserslist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "cache_ts": { "type": "number" }, "members": { "type": "array", "items": { "type": "object", "properties": { "color": { "type": "string" }, "deleted": { "type": "boolean" }, "has_2fa": { "type": "boolean" }, "id": { "type": "string" }, "is_admin": { "type": "boolean" }, "is_app_user": { "type": "boolean" }, "is_bot": { "type": "boolean" }, "is_owner": { "type": "boolean" }, "is_primary_owner": { "type": "boolean" }, "is_restricted": { "type": "boolean" }, "is_ultra_restricted": { "type": "boolean" }, "name": { "type": "string" }, "profile": { "type": "object", "properties": { "avatar_hash": { "type": "string" }, "display_name": { "type": "string" }, "display_name_normalized": { "type": "string" }, "email": { "type": "string" }, "image_192": { "type": "string" }, "image_24": { "type": "string" }, "image_32": { "type": "string" }, "image_48": { "type": "string" }, "image_512": { "type": "string" }, "image_72": { "type": "string" }, "real_name": { "type": "string" }, "real_name_normalized": { "type": "string" }, "status_emoji": { "type": "string" }, "status_text": { "type": "string" }, "team": { "type": "string" } } }, "real_name": { "type": "string" }, "team_id": { "type": "string" }, "tz": { "type": "string" }, "tz_label": { "type": "string" }, "tz_offset": { "type": "number" }, "updated": { "type": "number" } } } }, "ok": { "type": "boolean" }, "response_metadata": { "type": "object", "properties": { "next_cursor": { "type": "string" } } } } }, "example": { "cache_ts": 1498777272, "members": [ { "color": "9f69e7", "deleted": false, "has_2fa": false, "id": "W012A3CDE", "is_admin": true, "is_app_user": false, "is_bot": false, "is_owner": false, "is_primary_owner": false, "is_restricted": false, "is_ultra_restricted": false, "name": "spengler", "profile": { "avatar_hash": "ge3b51ca72de", "display_name": "spengler", "display_name_normalized": "spengler", "email": "spengler@ghostbusters.example.com", "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "real_name": "Egon Spengler", "real_name_normalized": "Egon Spengler", "status_emoji": ":books:", "status_text": "Print is dead", "team": "T012AB3C4" }, "real_name": "spengler", "team_id": "T012AB3C4", "tz": "America/Los_Angeles", "tz_label": "Pacific Daylight Time", "tz_offset": -25200, "updated": 1502138686 }, { "color": "9f69e7", "deleted": false, "has_2fa": false, "id": "W07QCRPA4", "is_admin": true, "is_bot": false, "is_owner": false, "is_primary_owner": false, "is_restricted": false, "is_ultra_restricted": false, "name": "glinda", "profile": { "avatar_hash": "8fbdd10b41c6", "display_name": "Glinda the Fairly Good", "display_name_normalized": "Glinda the Fairly Good", "email": "glenda@south.oz.coven", "first_name": "Glinda", "image_1024": "https://a.slack-edge.com...png", "image_192": "https://a.slack-edge.com...png", "image_24": "https://a.slack-edge.com...png", "image_32": "https://a.slack-edge.com...png", "image_48": "https://a.slack-edge.com...png", "image_512": "https://a.slack-edge.com...png", "image_72": "https://a.slack-edge.com...png", "image_original": "https://a.slack-edge.com...png", "last_name": "Southgood", "phone": "", "real_name": "Glinda Southgood", "real_name_normalized": "Glinda Southgood", "skype": "", "title": "Glinda the Good" }, "real_name": "Glinda Southgood", "team_id": "T0G9PQBBK", "tz": "America/Los_Angeles", "tz_label": "Pacific Daylight Time", "tz_offset": -25200, "updated": 1480527098 } ], "ok": true, "response_metadata": { "next_cursor": "dXNlcjpVMEc5V0ZYTlo=" } } } } } }, "parameters": [ { "name": "presence", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeLocale", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users.lookupByEmail": { "get": { "tags": [ "Users" ], "operationId": "getUserslookupByEmail", "description": "The parameters and request body are for method: getUserslookupByEmail. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "user": { "type": "object", "properties": { "color": { "type": "string" }, "deleted": { "type": "boolean" }, "has_2fa": { "type": "boolean" }, "id": { "type": "string" }, "is_admin": { "type": "boolean" }, "is_app_user": { "type": "boolean" }, "is_bot": { "type": "boolean" }, "is_owner": { "type": "boolean" }, "is_primary_owner": { "type": "boolean" }, "is_restricted": { "type": "boolean" }, "is_ultra_restricted": { "type": "boolean" }, "name": { "type": "string" }, "profile": { "type": "object", "properties": { "avatar_hash": { "type": "string" }, "display_name": { "type": "string" }, "display_name_normalized": { "type": "string" }, "email": { "type": "string" }, "image_192": { "type": "string" }, "image_24": { "type": "string" }, "image_32": { "type": "string" }, "image_48": { "type": "string" }, "image_512": { "type": "string" }, "image_72": { "type": "string" }, "real_name": { "type": "string" }, "real_name_normalized": { "type": "string" }, "status_emoji": { "type": "string" }, "status_text": { "type": "string" }, "team": { "type": "string" } } }, "real_name": { "type": "string" }, "team_id": { "type": "string" }, "tz": { "type": "string" }, "tz_label": { "type": "string" }, "tz_offset": { "type": "number" }, "updated": { "type": "number" } } } } }, "example": { "ok": true, "user": { "color": "9f69e7", "deleted": false, "has_2fa": false, "id": "W012A3CDE", "is_admin": true, "is_app_user": false, "is_bot": false, "is_owner": false, "is_primary_owner": false, "is_restricted": false, "is_ultra_restricted": false, "name": "spengler", "profile": { "avatar_hash": "ge3b51ca72de", "display_name": "spengler", "display_name_normalized": "spengler", "email": "spengler@ghostbusters.example.com", "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "real_name": "Egon Spengler", "real_name_normalized": "Egon Spengler", "status_emoji": ":books:", "status_text": "Print is dead", "team": "T012AB3C4" }, "real_name": "Egon Spengler", "team_id": "T012AB3C4", "tz": "America/Los_Angeles", "tz_label": "Pacific Daylight Time", "tz_offset": -25200, "updated": 1502138686 } } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users.setActive": { "post": { "tags": [ "Users" ], "operationId": "postUserssetActive", "description": "The parameters and request body are for method: postUserssetActive. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users.setPhoto": { "post": { "tags": [ "Users" ], "operationId": "postUserssetPhoto", "description": "The parameters and request body are for method: postUserssetPhoto. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users.setPresence": { "post": { "tags": [ "Users" ], "operationId": "postUserssetPresence", "description": "The parameters and request body are for method: postUserssetPresence. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } }, "example": { "ok": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "presence": { "type": "string" } } }, "example": { "presence": "presence" } } } } } }, "/users.profile.get": { "get": { "tags": [ "Usersprofile" ], "operationId": "getUsersprofileget", "description": "The parameters and request body are for method: getUsersprofileget. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "profile": { "type": "object", "properties": { "avatar_hash": { "type": "string" }, "display_name": { "type": "string" }, "display_name_normalized": { "type": "string" }, "email": { "type": "string" }, "image_192": { "type": "string" }, "image_24": { "type": "string" }, "image_32": { "type": "string" }, "image_48": { "type": "string" }, "image_512": { "type": "string" }, "image_72": { "type": "string" }, "real_name": { "type": "string" }, "real_name_normalized": { "type": "string" }, "status_emoji": { "type": "string" }, "status_text": { "type": "string" }, "team": { "type": "string" } } } } }, "example": { "ok": true, "profile": { "avatar_hash": "ge3b51ca72de", "display_name": "spengler", "display_name_normalized": "spengler", "email": "spengler@ghostbusters.example.com", "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "real_name": "Egon Spengler", "real_name_normalized": "Egon Spengler", "status_emoji": ":books:", "status_text": "Print is dead", "team": "T012AB3C4" } } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeLabels", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users.profile.set": { "post": { "tags": [ "Usersprofile" ], "operationId": "postUsersprofileset", "description": "The parameters and request body are for method: postUsersprofileset. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "profile": { "type": "object", "properties": { "avatar_hash": { "type": "string" }, "display_name": { "type": "string" }, "display_name_normalized": { "type": "string" }, "email": { "type": "string" }, "image_192": { "type": "string" }, "image_24": { "type": "string" }, "image_32": { "type": "string" }, "image_48": { "type": "string" }, "image_512": { "type": "string" }, "image_72": { "type": "string" }, "real_name": { "type": "string" }, "real_name_normalized": { "type": "string" }, "status_emoji": { "type": "string" }, "status_text": { "type": "string" }, "team": { "type": "string" } } } } }, "example": { "ok": true, "profile": { "avatar_hash": "ge3b51ca72de", "display_name": "spengler", "display_name_normalized": "spengler", "email": "spengler@ghostbusters.example.com", "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", "real_name": "Egon Spengler", "real_name_normalized": "Egon Spengler", "status_emoji": ":books:", "status_text": "Print is dead", "team": "T012AB3C4" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "type": "string" }, "user": { "type": "string" }, "value": { "type": "string" }, "name": { "type": "string" } } }, "example": { "profile": "profile", "user": "user", "value": "value", "name": "name" } } } } } } }, "components": { "schemas": {} } }