Slack


One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens blessed with related OAuth scopes.

HOST
slack.com

admin


admin users session reset


Wipes all valid sessions on all devices for a given user

post - /admin.users.session.reset
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "ok": true
}

api


api test


Checks API calling code.

Parameters

  • foo string

    example property to return

  • error string

    Error response to return

get - /api.test
200 - Standard success response
{
  "ok": true
}
default - Artificial error response
{
  "error": "string",
  "ok": true
}

apps


apps permissions info


Returns list of permissions this app has on a team.

Parameters

  • token string

    Authentication token. Requires scope: none

get - /apps.permissions.info
200 - Standard success response when used with a user token
{
  "info": {
    "app_home": {
      "resources": {
        "excluded_ids": [
          {},
          {},
          {}
        ],
        "ids": [
          {},
          {},
          {}
        ],
        "wildcard": true
      },
      "scopes": [
        {},
        {},
        {}
      ]
    },
    "channel": {
      "resources": {
        "excluded_ids": [
          {},
          {},
          {}
        ],
        "ids": [
          {},
          {},
          {}
        ],
        "wildcard": true
      },
      "scopes": [
        {},
        {},
        {}
      ]
    },
    "group": {
      "resources": {
        "excluded_ids": [
          {},
          {},
          {}
        ],
        "ids": [
          {},
          {},
          {}
        ],
        "wildcard": true
      },
      "scopes": [
        {},
        {},
        {}
      ]
    },
    "im": {
      "resources": {
        "excluded_ids": [
          {},
          {},
          {}
        ],
        "ids": [
          {},
          {},
          {}
        ],
        "wildcard": true
      },
      "scopes": [
        {},
        {},
        {}
      ]
    },
    "mpim": {
      "resources": {
        "excluded_ids": [
          {},
          {},
          {}
        ],
        "ids": [
          {},
          {},
          {}
        ],
        "wildcard": true
      },
      "scopes": [
        {},
        {},
        {}
      ]
    },
    "team": {
      "resources": {
        "excluded_ids": [
          {},
          {},
          {}
        ],
        "ids": [
          {},
          {},
          {}
        ],
        "wildcard": true
      },
      "scopes": [
        {},
        {},
        {}
      ]
    }
  },
  "ok": true
}
default - Standard failure response when used with an invalid token
{
  "error": "string",
  "ok": true
}

apps permissions request


Allows an app to request additional scopes

Parameters

  • scopes string

    A comma separated list of scopes to request for

  • token string

    Authentication token. Requires scope: none

  • trigger_id string

    Token used to trigger the permissions API

get - /apps.permissions.request
200 - Standard success response when used with a user token
{
  "ok": true
}
default - Standard failure response when trigger_id is invalid
{
  "error": "string",
  "ok": true
}

apps permissions resources list


Returns list of resource grants this app has on a team.

Parameters

  • cursor string

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.

  • token string

    Authentication token. Requires scope: none

  • limit integer

    The maximum number of items to return.

get - /apps.permissions.resources.list
200 - Typical successful paginated response
{
  "ok": true,
  "resources": [
    {
      "id": "string",
      "type": "string"
    },
    {
      "id": "string",
      "type": "string"
    },
    {
      "id": "string",
      "type": "string"
    }
  ],
  "response_metadata": {
    "next_cursor": "string"
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

apps permissions scopes list


Returns list of scopes this app has on a team.

Parameters

  • token string

    Authentication token. Requires scope: none

get - /apps.permissions.scopes.list
200 - Typical successful paginated response
{
  "ok": true,
  "scopes": {
    "app_home": [
      {},
      {},
      {}
    ],
    "channel": [
      {},
      {},
      {}
    ],
    "group": [
      {},
      {},
      {}
    ],
    "im": [
      {},
      {},
      {}
    ],
    "mpim": [
      {},
      {},
      {}
    ],
    "team": [
      {},
      {},
      {}
    ],
    "user": [
      {},
      {},
      {}
    ]
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

apps permissions users list


Returns list of user grants and corresponding scopes this app has on a team.

Parameters

  • cursor string

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.

  • token string

    Authentication token. Requires scope: none

  • limit integer

    The maximum number of items to return.

get - /apps.permissions.users.list
200 - Typical successful paginated response
{
  "ok": true
}
default - Typical error response
{
  "ok": true
}

apps permissions users request


Enables an app to trigger a permissions modal to grant an app access to a user access scope.

Parameters

  • scopes string

    A comma separated list of user scopes to request for

  • token string

    Authentication token. Requires scope: none

  • user string

    The user this scope is being requested for

  • trigger_id string

    Token used to trigger the request

get - /apps.permissions.users.request
200 - Standard success response when used with a user token
{
  "ok": true
}
default - Standard failure response when trigger_id is invalid
{
  "ok": true
}

apps uninstall


Uninstalls your app from a workspace.

Parameters

  • client_secret string

    Issued when you created your application.

  • token string

    Authentication token. Requires scope: none

  • client_id string

    Issued when you created your application.

get - /apps.uninstall
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

auth


auth revoke


Revokes a token.

Parameters

  • test boolean

    Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.

  • token string

    Authentication token. Requires scope: none

get - /auth.revoke
200 - Typical success response
{
  "ok": true,
  "revoked": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

auth test


Checks authentication & identity.

get - /auth.test
200 - Standard success response when used with a user token
{
  "ok": true,
  "team": "string",
  "team_id": "string",
  "url": "string",
  "user": "string",
  "user_id": "string"
}
default - Standard failure response when used with an invalid token
{
  "error": "string",
  "ok": true
}

bots


bots info


Gets information about a bot user.

Parameters

  • token string

    Authentication token. Requires scope: users:read

  • bot string

    Bot user to get info on

get - /bots.info
200 - When successful, returns bot info by bot ID.
{
  "bot": {
    "app_id": "string",
    "deleted": true,
    "icons": {
      "image_36": "string",
      "image_48": "string",
      "image_72": "string"
    },
    "id": "string",
    "name": "string",
    "updated": 123,
    "user_id": "string"
  },
  "ok": true
}
default - When no bot can be found, it returns an error.
{
  "error": "string",
  "ok": true
}

channels


channels archive


Archives a channel.

Parameters

  • token string

    Authentication token. Requires scope: channels:write

  • channel string

    Channel to archive

post - /channels.archive
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

channels create


Creates a channel.

Parameters

  • validate boolean

    Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

  • token string

    Authentication token. Requires scope: channels:write

  • name string

    Name of channel to create

post - /channels.create
200 - Typical success response resulting in a new channel
{
  "channel": {
    "accepted_user": "string",
    "created": 123,
    "creator": "string",
    "id": "string",
    "is_archived": true,
    "is_channel": true,
    "is_general": true,
    "is_member": true,
    "is_moved": 123,
    "is_mpim": true,
    "is_org_shared": true,
    "is_pending_ext_shared": true,
    "is_private": true,
    "is_read_only": true,
    "is_shared": true,
    "last_read": "string",
    "latest": "",
    "members": [
      {},
      {},
      {}
    ],
    "name": "string",
    "name_normalized": "string",
    "num_members": 123,
    "pending_shared": [
      {},
      {},
      {}
    ],
    "previous_names": [
      {},
      {},
      {}
    ],
    "priority": "",
    "purpose": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "topic": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "unlinked": 123,
    "unread_count": 123,
    "unread_count_display": 123
  },
  "ok": true
}
default - Example error response when an invalid name is provided
{
  "error": "string",
  "ok": true
}

channels history


Fetches history of messages and events from a channel.

Parameters

  • count integer

    Number of messages to return, between 1 and 1000.

  • unreads boolean

    Include unread_count_display in the output?

  • inclusive boolean

    Include messages with latest or oldest timestamp in results.

  • token string

    Authentication token. Requires scope: channels:history

  • oldest number

    Start of time range of messages to include in results.

  • channel string

    Channel to fetch history for.

  • latest number

    End of time range of messages to include in results.

get - /channels.history
200 - Typical success response containing the channel's history
{
  "has_more": true,
  "is_limited": true,
  "messages": [
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    },
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    },
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    }
  ],
  "ok": true
}
default - Error response when the specified channel cannot be found
{
  "error": "string",
  "ok": true
}

channels info


Gets information about a channel.

Parameters

  • token string

    Authentication token. Requires scope: channels:read

  • include_locale boolean

    Set this to true to receive the locale for this channel. Defaults to false

  • channel string

    Channel to get info on

get - /channels.info
200 - Typical success response
{
  "channel": {
    "accepted_user": "string",
    "created": 123,
    "creator": "string",
    "id": "string",
    "is_archived": true,
    "is_channel": true,
    "is_general": true,
    "is_member": true,
    "is_moved": 123,
    "is_mpim": true,
    "is_org_shared": true,
    "is_pending_ext_shared": true,
    "is_private": true,
    "is_read_only": true,
    "is_shared": true,
    "last_read": "string",
    "latest": "",
    "members": [
      {},
      {},
      {}
    ],
    "name": "string",
    "name_normalized": "string",
    "num_members": 123,
    "pending_shared": [
      {},
      {},
      {}
    ],
    "previous_names": [
      {},
      {},
      {}
    ],
    "priority": "",
    "purpose": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "topic": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "unlinked": 123,
    "unread_count": 123,
    "unread_count_display": 123
  },
  "ok": true
}
default - Error response when the specified channel cannot be found
{
  "error": "string",
  "ok": true
}

channels invite


Invites a user to a channel.

Parameters

  • token string

    Authentication token. Requires scope: channels:write

  • user string

    User to invite to channel.

  • channel string

    Channel to invite user to.

post - /channels.invite
200 - Typical success response
{
  "channel": {
    "accepted_user": "string",
    "created": 123,
    "creator": "string",
    "id": "string",
    "is_archived": true,
    "is_channel": true,
    "is_general": true,
    "is_member": true,
    "is_moved": 123,
    "is_mpim": true,
    "is_org_shared": true,
    "is_pending_ext_shared": true,
    "is_private": true,
    "is_read_only": true,
    "is_shared": true,
    "last_read": "string",
    "latest": "",
    "members": [
      {},
      {},
      {}
    ],
    "name": "string",
    "name_normalized": "string",
    "num_members": 123,
    "pending_shared": [
      {},
      {},
      {}
    ],
    "previous_names": [
      {},
      {},
      {}
    ],
    "priority": "",
    "purpose": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "topic": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "unlinked": 123,
    "unread_count": 123,
    "unread_count_display": 123
  },
  "ok": true
}
default - A somewhat typical error response
{
  "error": "string",
  "ok": true
}

channels join


Joins a channel, creating it if needed.

Parameters

  • validate boolean

    Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

  • token string

    Authentication token. Requires scope: channels:write

  • name string

    Name of channel to join

post - /channels.join
200 - Typical success response
{
  "already_in_channel": true,
  "channel": {
    "accepted_user": "string",
    "created": 123,
    "creator": "string",
    "id": "string",
    "is_archived": true,
    "is_channel": true,
    "is_general": true,
    "is_member": true,
    "is_moved": 123,
    "is_mpim": true,
    "is_org_shared": true,
    "is_pending_ext_shared": true,
    "is_private": true,
    "is_read_only": true,
    "is_shared": true,
    "last_read": "string",
    "latest": "",
    "members": [
      {},
      {},
      {}
    ],
    "name": "string",
    "name_normalized": "string",
    "num_members": 123,
    "pending_shared": [
      {},
      {},
      {}
    ],
    "previous_names": [
      {},
      {},
      {}
    ],
    "priority": "",
    "purpose": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "topic": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "unlinked": 123,
    "unread_count": 123,
    "unread_count_display": 123
  },
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

channels kick


Removes a user from a channel.

Parameters

  • token string

    Authentication token. Requires scope: channels:write

  • user string

    User to remove from channel.

  • channel string

    Channel to remove user from.

post - /channels.kick
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

channels leave


Leaves a channel.

Parameters

  • token string

    Authentication token. Requires scope: channels:write

  • channel string

    Channel to leave

post - /channels.leave
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

channels list


Lists all channels in a Slack team.

Parameters

  • exclude_members boolean

    Exclude the members collection from each channel

  • cursor string

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.

  • token string

    Authentication token. Requires scope: channels:read

  • limit integer

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.

  • exclude_archived boolean

    Exclude archived channels from the list

get - /channels.list
200 - Typical cursored success response
{
  "channels": [
    {
      "accepted_user": "string",
      "created": 123,
      "creator": "string",
      "id": "string",
      "is_archived": true,
      "is_channel": true,
      "is_general": true,
      "is_member": true,
      "is_moved": 123,
      "is_mpim": true,
      "is_org_shared": true,
      "is_pending_ext_shared": true,
      "is_private": true,
      "is_read_only": true,
      "is_shared": true,
      "last_read": "string",
      "latest": "",
      "members": [
        {},
        {},
        {}
      ],
      "name": "string",
      "name_normalized": "string",
      "num_members": 123,
      "pending_shared": [
        {},
        {},
        {}
      ],
      "previous_names": [
        {},
        {},
        {}
      ],
      "priority": "",
      "purpose": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "topic": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "unlinked": 123,
      "unread_count": 123,
      "unread_count_display": 123
    },
    {
      "accepted_user": "string",
      "created": 123,
      "creator": "string",
      "id": "string",
      "is_archived": true,
      "is_channel": true,
      "is_general": true,
      "is_member": true,
      "is_moved": 123,
      "is_mpim": true,
      "is_org_shared": true,
      "is_pending_ext_shared": true,
      "is_private": true,
      "is_read_only": true,
      "is_shared": true,
      "last_read": "string",
      "latest": "",
      "members": [
        {},
        {},
        {}
      ],
      "name": "string",
      "name_normalized": "string",
      "num_members": 123,
      "pending_shared": [
        {},
        {},
        {}
      ],
      "previous_names": [
        {},
        {},
        {}
      ],
      "priority": "",
      "purpose": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "topic": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "unlinked": 123,
      "unread_count": 123,
      "unread_count_display": 123
    },
    {
      "accepted_user": "string",
      "created": 123,
      "creator": "string",
      "id": "string",
      "is_archived": true,
      "is_channel": true,
      "is_general": true,
      "is_member": true,
      "is_moved": 123,
      "is_mpim": true,
      "is_org_shared": true,
      "is_pending_ext_shared": true,
      "is_private": true,
      "is_read_only": true,
      "is_shared": true,
      "last_read": "string",
      "latest": "",
      "members": [
        {},
        {},
        {}
      ],
      "name": "string",
      "name_normalized": "string",
      "num_members": 123,
      "pending_shared": [
        {},
        {},
        {}
      ],
      "previous_names": [
        {},
        {},
        {}
      ],
      "priority": "",
      "purpose": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "topic": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "unlinked": 123,
      "unread_count": 123,
      "unread_count_display": 123
    }
  ],
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

channels mark


Sets the read cursor in a channel.

Parameters

  • token string

    Authentication token. Requires scope: channels:write

  • ts number

    Timestamp of the most recently seen message.

  • channel string

    Channel to set reading cursor in.

post - /channels.mark
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

channels rename


Renames a channel.

Parameters

  • validate boolean

    Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

  • token string

    Authentication token. Requires scope: channels:write

  • name string

    New name for channel.

  • channel string

    Channel to rename

post - /channels.rename
200 - Typical success response
{
  "channel": {
    "accepted_user": "string",
    "created": 123,
    "creator": "string",
    "id": "string",
    "is_archived": true,
    "is_channel": true,
    "is_general": true,
    "is_member": true,
    "is_moved": 123,
    "is_mpim": true,
    "is_org_shared": true,
    "is_pending_ext_shared": true,
    "is_private": true,
    "is_read_only": true,
    "is_shared": true,
    "last_read": "string",
    "latest": "",
    "members": [
      {},
      {},
      {}
    ],
    "name": "string",
    "name_normalized": "string",
    "num_members": 123,
    "pending_shared": [
      {},
      {},
      {}
    ],
    "previous_names": [
      {},
      {},
      {}
    ],
    "priority": "",
    "purpose": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "topic": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "unlinked": 123,
    "unread_count": 123,
    "unread_count_display": 123
  },
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

channels replies


Retrieve a thread of messages posted to a channel

Parameters

  • thread_ts number

    Unique identifier of a thread's parent message

  • token string

    Authentication token. Requires scope: channels:history

  • channel string

    Channel to fetch thread from

get - /channels.replies
200 - Typical success response
{
  "has_more": true,
  "messages": [
    {},
    {},
    {}
  ],
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

channels setPurpose


Sets the purpose for a channel.

Parameters

  • token string

    Authentication token. Requires scope: channels:write

  • purpose string

    The new purpose

  • channel string

    Channel to set the purpose of

post - /channels.setPurpose
200 - Typical success response
{
  "ok": true,
  "purpose": "string"
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

channels setTopic


Sets the topic for a channel.

Parameters

  • topic string

    The new topic

  • token string

    Authentication token. Requires scope: channels:write

  • channel string

    Channel to set the topic of

post - /channels.setTopic
200 - Typical success response
{
  "ok": true,
  "topic": "string"
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

channels unarchive


Unarchives a channel.

Parameters

  • token string

    Authentication token. Requires scope: channels:write

  • channel string

    Channel to unarchive

post - /channels.unarchive
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

chat


chat delete


Deletes a message.

Parameters

  • as_user boolean

    Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.

  • token string

    Authentication token. Requires scope: chat:write

  • ts number

    Timestamp of the message to be deleted.

  • channel string

    Channel containing the message to be deleted.

post - /chat.delete
200 - Typical success response
{
  "channel": "string",
  "ok": true,
  "ts": "string"
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

chat deleteScheduledMessage


Deletes a pending scheduled message from the queue.

post - /chat.deleteScheduledMessage
200 - Typical success response
{
  "ok": true
}
default - Typical error response if no message is found
{
  "error": "string",
  "ok": true
}


chat meMessage


Share a me message into a channel.

Parameters

  • text string

    Text of the message to send.

  • token string

    Authentication token. Requires scope: chat:write:user

  • channel string

    Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.

post - /chat.meMessage
200 - Typical success response
{
  "channel": "string",
  "ok": true,
  "ts": "string"
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

chat postEphemeral


Sends an ephemeral message to a user in a channel.

Parameters

  • thread_ts number

    Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.

  • blocks string

    A JSON-based array of structured blocks, presented as a URL-encoded string.

  • attachments string

    A JSON-based array of structured attachments, presented as a URL-encoded string.

  • as_user boolean

    Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.

  • parse string

    Change how messages are treated. Defaults to none. See below.

  • token string

    Authentication token. Requires scope: chat:write

  • text string

    Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead.

  • user string

    id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.

  • link_names boolean

    Find and link channel names and usernames.

  • channel string

    Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.

post - /chat.postEphemeral
200 - Typical success response
{
  "message_ts": "string",
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

chat postMessage


Sends a message to a channel.

Parameters

  • attachments string

    A JSON-based array of structured attachments, presented as a URL-encoded string.

  • unfurl_links boolean

    Pass true to enable unfurling of primarily text-based content.

  • text string

    Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead. Provide no more than 40,000 characters or risk truncation.

  • unfurl_media boolean

    Pass false to disable unfurling of media content.

  • parse string

    Change how messages are treated. Defaults to none. See below.

  • as_user boolean

    Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.

  • mrkdwn boolean

    Disable Slack markup parsing by setting to false. Enabled by default.

  • channel string

    Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.

  • username string

    Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

  • blocks string

    A JSON-based array of structured blocks, presented as a URL-encoded string.

  • icon_emoji string

    Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

  • link_names boolean

    Find and link channel names and usernames.

  • reply_broadcast boolean

    Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.

  • thread_ts number

    Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.

  • token string

    Authentication token. Requires scope: chat:write

  • icon_url string

    URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

post - /chat.postMessage
200 - Typical success response
{
  "channel": "string",
  "message": {
    "attachments": [
      {
        "fallback": "string",
        "id": 123,
        "image_bytes": 123,
        "image_height": 123,
        "image_url": "string",
        "image_width": 123
      },
      {
        "fallback": "string",
        "id": 123,
        "image_bytes": 123,
        "image_height": 123,
        "image_url": "string",
        "image_width": 123
      },
      {
        "fallback": "string",
        "id": 123,
        "image_bytes": 123,
        "image_height": 123,
        "image_url": "string",
        "image_width": 123
      }
    ],
    "blocks": [
      {
        "type": "string"
      },
      {
        "type": "string"
      },
      {
        "type": "string"
      }
    ],
    "bot_id": "",
    "client_msg_id": "string",
    "comment": {
      "comment": "string",
      "created": 123,
      "id": "string",
      "is_intro": true,
      "is_starred": true,
      "num_stars": 123,
      "pinned_info": {},
      "pinned_to": [
        {},
        {},
        {}
      ],
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "timestamp": 123,
      "user": "string"
    },
    "display_as_bot": true,
    "file": {
      "channels": [
        {},
        {},
        {}
      ],
      "comments_count": 123,
      "created": 123,
      "display_as_bot": true,
      "editable": true,
      "editor": "string",
      "external_id": "string",
      "external_type": "string",
      "external_url": "string",
      "filetype": "string",
      "groups": [
        {},
        {},
        {}
      ],
      "has_rich_preview": true,
      "id": "string",
      "image_exif_rotation": 123,
      "ims": [
        {},
        {},
        {}
      ],
      "is_external": true,
      "is_public": true,
      "is_starred": true,
      "is_tombstoned": true,
      "last_editor": "string",
      "mimetype": "string",
      "mode": "string",
      "name": "string",
      "num_stars": 123,
      "original_h": 123,
      "original_w": 123,
      "permalink": "string",
      "permalink_public": "string",
      "pinned_info": {},
      "pinned_to": [
        {},
        {},
        {}
      ],
      "pretty_type": "string",
      "preview": "",
      "public_url_shared": true,
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "shares": {
        "private": "",
        "public": ""
      },
      "size": 123,
      "source_team": "string",
      "state": "string",
      "thumb_1024": "string",
      "thumb_1024_h": 123,
      "thumb_1024_w": 123,
      "thumb_160": "string",
      "thumb_360": "string",
      "thumb_360_h": 123,
      "thumb_360_w": 123,
      "thumb_480": "string",
      "thumb_480_h": 123,
      "thumb_480_w": 123,
      "thumb_64": "string",
      "thumb_720": "string",
      "thumb_720_h": 123,
      "thumb_720_w": 123,
      "thumb_80": "string",
      "thumb_800": "string",
      "thumb_800_h": 123,
      "thumb_800_w": 123,
      "thumb_960": "string",
      "thumb_960_h": 123,
      "thumb_960_w": 123,
      "timestamp": 123,
      "title": "string",
      "updated": 123,
      "url_private": "string",
      "url_private_download": "string",
      "user": "string",
      "user_team": "string",
      "username": "string"
    },
    "files": [
      {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      }
    ],
    "icons": {
      "emoji": "string"
    },
    "inviter": "string",
    "is_delayed_message": true,
    "is_intro": true,
    "is_starred": true,
    "last_read": "string",
    "latest_reply": "string",
    "name": "string",
    "old_name": "string",
    "parent_user_id": "string",
    "permalink": "string",
    "pinned_to": [
      {},
      {},
      {}
    ],
    "purpose": "string",
    "reactions": [
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      },
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      },
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      }
    ],
    "replies": [
      {
        "ts": "string",
        "user": "string"
      },
      {
        "ts": "string",
        "user": "string"
      },
      {
        "ts": "string",
        "user": "string"
      }
    ],
    "reply_count": 123,
    "reply_users": [
      {},
      {},
      {}
    ],
    "reply_users_count": 123,
    "source_team": "string",
    "subscribed": true,
    "subtype": "string",
    "team": "string",
    "text": "string",
    "thread_ts": "string",
    "topic": "string",
    "ts": "string",
    "type": "string",
    "unread_count": 123,
    "upload": true,
    "user": "string",
    "user_profile": {
      "avatar_hash": "string",
      "display_name": "string",
      "first_name": "string",
      "image_72": "string",
      "is_restricted": true,
      "is_ultra_restricted": true,
      "name": "string",
      "real_name": "string",
      "team": "string"
    },
    "user_team": "string",
    "username": "string"
  },
  "ok": true,
  "ts": "string"
}
default - Typical error response if too many attachments are included
{
  "error": "string",
  "ok": true
}

chat scheduleMessage


Schedules a message to be sent to a channel.

Parameters

  • thread_ts number

    Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.

  • blocks string

    A JSON-based array of structured blocks, presented as a URL-encoded string.

  • attachments string

    A JSON-based array of structured attachments, presented as a URL-encoded string.

  • unfurl_links boolean

    Pass true to enable unfurling of primarily text-based content.

  • text string

    Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead. Provide no more than 40,000 characters or risk truncation.

  • link_names boolean

    Find and link channel names and usernames.

  • unfurl_media boolean

    Pass false to disable unfurling of media content.

  • parse string

    Change how messages are treated. Defaults to none. See below.

  • token string

    Authentication token. Requires scope: chat:write

  • as_user boolean

    Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.

  • post_at string

    Unix EPOCH timestamp of time in future to send the message.

  • channel string

    Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.

  • reply_broadcast boolean

    Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.

post - /chat.scheduleMessage
200 - Typical success response
{
  "channel": "string",
  "message": {
    "bot_id": "string",
    "text": "string",
    "type": "string",
    "user": "string",
    "username": "string"
  },
  "ok": true,
  "post_at": 123,
  "scheduled_message_id": "string"
}
default - Typical error response if the `post_at` is invalid (ex. in the past or too far into the future)
{
  "error": "string",
  "ok": true
}

chat scheduledMessages list


Returns a list of scheduled messages.

Parameters

  • cursor string

    For pagination purposes, this is the cursor value returned from a previous call to chat.scheduledmessages.list indicating where you want to start this call from.

  • token string

    Authentication token. Requires scope: none

  • limit integer

    Maximum number of original entries to return.

  • oldest number

    A UNIX timestamp of the oldest value in the time range

  • channel string

    The channel of the scheduled messages

  • latest number

    A UNIX timestamp of the latest value in the time range

get - /chat.scheduledMessages.list
200 - Typical success response
{
  "ok": true,
  "response_metadata": {
    "next_cursor": "string"
  },
  "scheduled_messages": [
    {
      "channel_id": "string",
      "date_created": 123,
      "id": "string",
      "post_at": 123
    },
    {
      "channel_id": "string",
      "date_created": 123,
      "id": "string",
      "post_at": 123
    },
    {
      "channel_id": "string",
      "date_created": 123,
      "id": "string",
      "post_at": 123
    }
  ]
}
default - Typical error response if the channel passed is invalid
{
  "error": "string",
  "ok": true
}

chat unfurl


Provide custom unfurl behavior for user-posted URLs

Parameters

  • user_auth_message string

    Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior

  • user_auth_required boolean

    Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain

  • unfurls string

    URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.

  • ts string

    Timestamp of the message to add unfurl behavior to.

  • user_auth_url string

    Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.

  • token string

    Authentication token. Requires scope: links:write

  • channel string

    Channel ID of the message

post - /chat.unfurl
200 - Typical, minimal success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

chat update


Updates a message.

Parameters

  • blocks string

    A JSON-based array of structured blocks, presented as a URL-encoded string.

  • attachments string

    A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text.

  • text string

    New text for the message, using the default formatting rules. It's not required when presenting attachments.

  • ts number

    Timestamp of the message to be updated.

  • parse string

    Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.

  • as_user boolean

    Pass true to update the message as the authed user. Bot users in this context are considered authed users.

  • token string

    Authentication token. Requires scope: chat:write

  • link_names boolean

    Find and link channel names and usernames. Defaults to none. See below.

  • channel string

    Channel containing the message to be updated.

post - /chat.update
200 - Typical success response
{
  "channel": "string",
  "message": {
    "team": "string",
    "text": "string",
    "type": "string",
    "user": "string"
  },
  "ok": true,
  "text": "string",
  "ts": "string"
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

conversations


conversations archive


Archives a conversation.

Parameters

  • token string

    Authentication token. Requires scope: conversations:write

  • channel string

    ID of conversation to archive

post - /conversations.archive
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations close


Closes a direct message or multi-person direct message.

Parameters

  • token string

    Authentication token. Requires scope: conversations:write

  • channel string

    Conversation to close.

post - /conversations.close
200 - Typical success response
{
  "already_closed": true,
  "no_op": true,
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations create


Initiates a public or private channel-based conversation

Parameters

  • token string

    Authentication token. Requires scope: conversations:write

  • user_ids string

    Required for workspace apps. A list of between 1 and 30 human users that will be added to the newly-created conversation. This argument has no effect when used by classic Slack apps.

  • name string

    Name of the public or private channel to create

  • is_private boolean

    Create a private channel instead of a public one

post - /conversations.create
200 - If successful, the command returns a rather stark [conversation object](/types/conversation)
{
  "channel": "",
  "ok": true
}
default - Typical error response when name already in use
{
  "detail": "string",
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations history


Fetches a conversation's history of messages and events.

Parameters

  • inclusive boolean

    Include messages with latest or oldest timestamp in results only when either timestamp is specified.

  • cursor string

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.

  • token string

    Authentication token. Requires scope: conversations:history

  • limit integer

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.

  • oldest number

    Start of time range of messages to include in results.

  • channel string

    Conversation ID to fetch history for.

  • latest number

    End of time range of messages to include in results.

get - /conversations.history
200 - Typical success response containing a channel's messages
{
  "has_more": true,
  "messages": [
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    },
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    },
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    }
  ],
  "ok": true,
  "pin_count": 123
}
default - Typical error response
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations info


Retrieve information about a conversation.

Parameters

  • include_num_members boolean

    Set to true to include the member count for the specified conversation. Defaults to false

  • token string

    Authentication token. Requires scope: conversations:read

  • channel string

    Conversation ID to learn more about

  • include_locale boolean

    Set this to true to receive the locale for this conversation. Defaults to false

get - /conversations.info
200 - Typical success response for a public channel. (Also, a response from a private channel and a multi-party IM is very similar to this example.)
{
  "channel": "",
  "ok": true
}
default - Typical error response when a channel cannot be found
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations invite


Invites users to a channel.

Parameters

  • token string

    Authentication token. Requires scope: conversations:write

  • users string

    A comma separated list of user IDs. Up to 30 users may be listed.

  • channel string

    The ID of the public or private channel to invite user(s) to.

post - /conversations.invite
200 - Typical success response when an invitation is extended
{
  "channel": "",
  "ok": true
}
default - Typical error response when an invite is attempted on a conversation type that does not support it
{
  "error": "string",
  "errors": [
    {
      "error": "string",
      "ok": true,
      "user": "string"
    },
    {
      "error": "string",
      "ok": true,
      "user": "string"
    },
    {
      "error": "string",
      "ok": true,
      "user": "string"
    }
  ],
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations join


Joins an existing conversation.

Parameters

  • token string

    Authentication token. Requires scope: channels:write

  • channel string

    ID of conversation to join

post - /conversations.join
200 - Typical success response
{
  "channel": "",
  "ok": true,
  "response_metadata": {
    "warnings": [
      {},
      {},
      {}
    ]
  },
  "warning": "string"
}
default - Typical error response if the conversation is archived and cannot be joined
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations kick


Removes a user from a conversation.

Parameters

  • token string

    Authentication token. Requires scope: conversations:write

  • user string

    User ID to be removed.

  • channel string

    ID of conversation to remove user from.

post - /conversations.kick
200 - Typical success response
{
  "ok": true
}
default - Typical error response when you attempt to kick yourself from a channel
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations leave


Leaves a conversation.

Parameters

  • token string

    Authentication token. Requires scope: conversations:write

  • channel string

    Conversation to leave

post - /conversations.leave
200 - Typical success response
{
  "not_in_channel": true,
  "ok": true
}
default - Typical error response when attempting to leave a workspace's "general" channel
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations list


Lists all channels in a Slack team.

Parameters

  • cursor string

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.

  • token string

    Authentication token. Requires scope: conversations:read

  • limit integer

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.

  • exclude_archived boolean

    Set to true to exclude archived channels from the list

  • types string

    Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im

get - /conversations.list
200 - Typical success response with only public channels
{
  "channels": [
    {},
    {},
    {}
  ],
  "ok": true,
  "response_metadata": {
    "next_cursor": "string"
  }
}
default - Typical error response
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations members


Retrieve members of a conversation.

Parameters

  • cursor string

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.

  • token string

    Authentication token. Requires scope: conversations:read

  • limit integer

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.

  • channel string

    ID of the conversation to retrieve members for

get - /conversations.members
200 - Typical paginated success response
{
  "members": [
    {},
    {},
    {}
  ],
  "ok": true,
  "response_metadata": {
    "next_cursor": "string"
  }
}
default - Typical error response when an invalid cursor is provided
{
  "error": "string",
  "ok": true
}

conversations open


Opens or resumes a direct message or multi-person direct message.

Parameters

  • token string

    Authentication token. Requires scope: conversations:write

  • return_im boolean

    Boolean, indicates you want the full IM channel definition in the response.

  • users string

    Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.

  • channel string

    Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead.

post - /conversations.open
200 - Typical success response
{
  "already_open": true,
  "channel": "",
  "no_op": true,
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

conversations rename


Renames a conversation.

Parameters

  • token string

    Authentication token. Requires scope: conversations:write

  • name string

    New name for conversation.

  • channel string

    ID of conversation to rename

post - /conversations.rename
200 - Typical success response
{
  "channel": "",
  "ok": true
}
default - Typical error response when the calling user is not a member of the conversation
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations replies


Retrieve a thread of messages posted to a conversation

Parameters

  • inclusive boolean

    Include messages with latest or oldest timestamp in results only when either timestamp is specified.

  • ts number

    Unique identifier of a thread's parent message.

  • cursor string

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.

  • token string

    Authentication token. Requires scope: conversations:history

  • limit integer

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.

  • oldest number

    Start of time range of messages to include in results.

  • channel string

    Conversation ID to fetch thread from.

  • latest number

    End of time range of messages to include in results.

get - /conversations.replies
200 - Typical success response
{
  "has_more": true,
  "messages": [
    {},
    {},
    {}
  ],
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations setPurpose


Sets the purpose for a conversation.

Parameters

  • token string

    Authentication token. Requires scope: conversations:write

  • purpose string

    A new, specialer purpose

  • channel string

    Conversation to set the purpose of

post - /conversations.setPurpose
200 - Typical success response
{
  "channel": "",
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations setTopic


Sets the topic for a conversation.

Parameters

  • topic string

    The new topic string. Does not support formatting or linkification.

  • token string

    Authentication token. Requires scope: conversations:write

  • channel string

    Conversation to set the topic of

post - /conversations.setTopic
200 - Typical success response
{
  "channel": "",
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

conversations unarchive


Reverses conversation archival.

Parameters

  • token string

    Authentication token. Requires scope: conversations:write

  • channel string

    ID of conversation to unarchive

post - /conversations.unarchive
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

dialog


dialog open


Open a dialog with a user

get - /dialog.open
200 - Typical success response is quite minimal.
{
  "ok": true
}
default - Typical error response, before getting to any possible validation errors.
{
  "error": "string",
  "ok": true
}

dnd


dnd endDnd


Ends the current user's Do Not Disturb session immediately.

post - /dnd.endDnd
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

dnd endSnooze


Ends the current user's snooze mode immediately.

post - /dnd.endSnooze
200 - Typical success response
{
  "dnd_enabled": true,
  "next_dnd_end_ts": 123,
  "next_dnd_start_ts": 123,
  "ok": true,
  "snooze_enabled": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

dnd info


Retrieves a user's current Do Not Disturb status.

Parameters

  • token string

    Authentication token. Requires scope: dnd:read

  • user string

    User to fetch status for (defaults to current user)

get - /dnd.info
200 - Typical success response
{
  "dnd_enabled": true,
  "next_dnd_end_ts": 123,
  "next_dnd_start_ts": 123,
  "ok": true,
  "snooze_enabled": true,
  "snooze_endtime": 123,
  "snooze_remaining": 123
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

dnd setSnooze


Turns on Do Not Disturb mode for the current user, or changes its duration.

post - /dnd.setSnooze
200 - Typical success response
{
  "ok": true,
  "snooze_enabled": true,
  "snooze_endtime": 123,
  "snooze_remaining": 123
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

dnd teamInfo


Retrieves the Do Not Disturb status for up to 50 users on a team.

Parameters

  • token string

    Authentication token. Requires scope: dnd:read

  • users string

    Comma-separated list of users to fetch Do Not Disturb status for

get - /dnd.teamInfo
200 - Typical success response
{
  "cached": true,
  "ok": true,
  "users": {}
}
default - Typical error response
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

emoji


emoji list


Lists custom emoji for a team.

Parameters

  • token string

    Authentication token. Requires scope: emoji:read

get - /emoji.list
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "ok": true
}

files


files comments delete


Deletes an existing comment on a file.

Parameters

  • token string

    Authentication token. Requires scope: files:write:user

  • id string

    The comment to delete.

  • file string

    File to delete a comment from.

post - /files.comments.delete
200 - Standard success response is very simple
{
  "ok": true
}
default - Standard failure response when used with an invalid token
{
  "error": "string",
  "ok": true
}

files delete


Deletes a file.

Parameters

  • token string

    Authentication token. Requires scope: files:write:user

  • file string

    ID of file to delete.

post - /files.delete
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

files info


Gets information about a team file.

Parameters

  • count string
  • cursor string

    Parameter for pagination. File comments are paginated for a single file. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection of comments. See pagination for more details.

  • token string

    Authentication token. Requires scope: files:read

  • limit integer

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.

  • file string

    Specify a file by providing its ID.

  • page string
get - /files.info
200 - Typical success response
{
  "comments": [
    {},
    {},
    {}
  ],
  "content_html": "",
  "editor": "string",
  "file": {
    "channels": [
      {},
      {},
      {}
    ],
    "comments_count": 123,
    "created": 123,
    "display_as_bot": true,
    "editable": true,
    "editor": "string",
    "external_id": "string",
    "external_type": "string",
    "external_url": "string",
    "filetype": "string",
    "groups": [
      {},
      {},
      {}
    ],
    "has_rich_preview": true,
    "id": "string",
    "image_exif_rotation": 123,
    "ims": [
      {},
      {},
      {}
    ],
    "is_external": true,
    "is_public": true,
    "is_starred": true,
    "is_tombstoned": true,
    "last_editor": "string",
    "mimetype": "string",
    "mode": "string",
    "name": "string",
    "num_stars": 123,
    "original_h": 123,
    "original_w": 123,
    "permalink": "string",
    "permalink_public": "string",
    "pinned_info": {},
    "pinned_to": [
      {},
      {},
      {}
    ],
    "pretty_type": "string",
    "preview": "",
    "public_url_shared": true,
    "reactions": [
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      },
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      },
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      }
    ],
    "shares": {
      "private": "",
      "public": ""
    },
    "size": 123,
    "source_team": "string",
    "state": "string",
    "thumb_1024": "string",
    "thumb_1024_h": 123,
    "thumb_1024_w": 123,
    "thumb_160": "string",
    "thumb_360": "string",
    "thumb_360_h": 123,
    "thumb_360_w": 123,
    "thumb_480": "string",
    "thumb_480_h": 123,
    "thumb_480_w": 123,
    "thumb_64": "string",
    "thumb_720": "string",
    "thumb_720_h": 123,
    "thumb_720_w": 123,
    "thumb_80": "string",
    "thumb_800": "string",
    "thumb_800_h": 123,
    "thumb_800_w": 123,
    "thumb_960": "string",
    "thumb_960_h": 123,
    "thumb_960_w": 123,
    "timestamp": 123,
    "title": "string",
    "updated": 123,
    "url_private": "string",
    "url_private_download": "string",
    "user": "string",
    "user_team": "string",
    "username": "string"
  },
  "ok": true,
  "paging": {
    "count": 123,
    "page": 123,
    "pages": 123,
    "per_page": 123,
    "spill": 123,
    "total": 123
  },
  "response_metadata": {
    "next_cursor": "string"
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

files list


Lists & filters team files.

Parameters

  • count string
  • channel string

    Filter files appearing in a specific channel, indicated by its ID.

  • ts_to number

    Filter files created before this timestamp (inclusive).

  • ts_from number

    Filter files created after this timestamp (inclusive).

  • token string

    Authentication token. Requires scope: files:read

  • user string

    Filter files created by a single user.

  • page string
  • types string

    Filter files by type (see below). You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list.

get - /files.list
200 - Typical success response
{
  "files": [
    {
      "channels": [
        {},
        {},
        {}
      ],
      "comments_count": 123,
      "created": 123,
      "display_as_bot": true,
      "editable": true,
      "editor": "string",
      "external_id": "string",
      "external_type": "string",
      "external_url": "string",
      "filetype": "string",
      "groups": [
        {},
        {},
        {}
      ],
      "has_rich_preview": true,
      "id": "string",
      "image_exif_rotation": 123,
      "ims": [
        {},
        {},
        {}
      ],
      "is_external": true,
      "is_public": true,
      "is_starred": true,
      "is_tombstoned": true,
      "last_editor": "string",
      "mimetype": "string",
      "mode": "string",
      "name": "string",
      "num_stars": 123,
      "original_h": 123,
      "original_w": 123,
      "permalink": "string",
      "permalink_public": "string",
      "pinned_info": {},
      "pinned_to": [
        {},
        {},
        {}
      ],
      "pretty_type": "string",
      "preview": "",
      "public_url_shared": true,
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "shares": {
        "private": "",
        "public": ""
      },
      "size": 123,
      "source_team": "string",
      "state": "string",
      "thumb_1024": "string",
      "thumb_1024_h": 123,
      "thumb_1024_w": 123,
      "thumb_160": "string",
      "thumb_360": "string",
      "thumb_360_h": 123,
      "thumb_360_w": 123,
      "thumb_480": "string",
      "thumb_480_h": 123,
      "thumb_480_w": 123,
      "thumb_64": "string",
      "thumb_720": "string",
      "thumb_720_h": 123,
      "thumb_720_w": 123,
      "thumb_80": "string",
      "thumb_800": "string",
      "thumb_800_h": 123,
      "thumb_800_w": 123,
      "thumb_960": "string",
      "thumb_960_h": 123,
      "thumb_960_w": 123,
      "timestamp": 123,
      "title": "string",
      "updated": 123,
      "url_private": "string",
      "url_private_download": "string",
      "user": "string",
      "user_team": "string",
      "username": "string"
    },
    {
      "channels": [
        {},
        {},
        {}
      ],
      "comments_count": 123,
      "created": 123,
      "display_as_bot": true,
      "editable": true,
      "editor": "string",
      "external_id": "string",
      "external_type": "string",
      "external_url": "string",
      "filetype": "string",
      "groups": [
        {},
        {},
        {}
      ],
      "has_rich_preview": true,
      "id": "string",
      "image_exif_rotation": 123,
      "ims": [
        {},
        {},
        {}
      ],
      "is_external": true,
      "is_public": true,
      "is_starred": true,
      "is_tombstoned": true,
      "last_editor": "string",
      "mimetype": "string",
      "mode": "string",
      "name": "string",
      "num_stars": 123,
      "original_h": 123,
      "original_w": 123,
      "permalink": "string",
      "permalink_public": "string",
      "pinned_info": {},
      "pinned_to": [
        {},
        {},
        {}
      ],
      "pretty_type": "string",
      "preview": "",
      "public_url_shared": true,
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "shares": {
        "private": "",
        "public": ""
      },
      "size": 123,
      "source_team": "string",
      "state": "string",
      "thumb_1024": "string",
      "thumb_1024_h": 123,
      "thumb_1024_w": 123,
      "thumb_160": "string",
      "thumb_360": "string",
      "thumb_360_h": 123,
      "thumb_360_w": 123,
      "thumb_480": "string",
      "thumb_480_h": 123,
      "thumb_480_w": 123,
      "thumb_64": "string",
      "thumb_720": "string",
      "thumb_720_h": 123,
      "thumb_720_w": 123,
      "thumb_80": "string",
      "thumb_800": "string",
      "thumb_800_h": 123,
      "thumb_800_w": 123,
      "thumb_960": "string",
      "thumb_960_h": 123,
      "thumb_960_w": 123,
      "timestamp": 123,
      "title": "string",
      "updated": 123,
      "url_private": "string",
      "url_private_download": "string",
      "user": "string",
      "user_team": "string",
      "username": "string"
    },
    {
      "channels": [
        {},
        {},
        {}
      ],
      "comments_count": 123,
      "created": 123,
      "display_as_bot": true,
      "editable": true,
      "editor": "string",
      "external_id": "string",
      "external_type": "string",
      "external_url": "string",
      "filetype": "string",
      "groups": [
        {},
        {},
        {}
      ],
      "has_rich_preview": true,
      "id": "string",
      "image_exif_rotation": 123,
      "ims": [
        {},
        {},
        {}
      ],
      "is_external": true,
      "is_public": true,
      "is_starred": true,
      "is_tombstoned": true,
      "last_editor": "string",
      "mimetype": "string",
      "mode": "string",
      "name": "string",
      "num_stars": 123,
      "original_h": 123,
      "original_w": 123,
      "permalink": "string",
      "permalink_public": "string",
      "pinned_info": {},
      "pinned_to": [
        {},
        {},
        {}
      ],
      "pretty_type": "string",
      "preview": "",
      "public_url_shared": true,
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "shares": {
        "private": "",
        "public": ""
      },
      "size": 123,
      "source_team": "string",
      "state": "string",
      "thumb_1024": "string",
      "thumb_1024_h": 123,
      "thumb_1024_w": 123,
      "thumb_160": "string",
      "thumb_360": "string",
      "thumb_360_h": 123,
      "thumb_360_w": 123,
      "thumb_480": "string",
      "thumb_480_h": 123,
      "thumb_480_w": 123,
      "thumb_64": "string",
      "thumb_720": "string",
      "thumb_720_h": 123,
      "thumb_720_w": 123,
      "thumb_80": "string",
      "thumb_800": "string",
      "thumb_800_h": 123,
      "thumb_800_w": 123,
      "thumb_960": "string",
      "thumb_960_h": 123,
      "thumb_960_w": 123,
      "timestamp": 123,
      "title": "string",
      "updated": 123,
      "url_private": "string",
      "url_private_download": "string",
      "user": "string",
      "user_team": "string",
      "username": "string"
    }
  ],
  "ok": true,
  "paging": {
    "count": 123,
    "page": 123,
    "pages": 123,
    "per_page": 123,
    "spill": 123,
    "total": 123
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

files revokePublicURL


Revokes public/external sharing access for a file

Parameters

  • token string

    Authentication token. Requires scope: files:write:user

  • file string

    File to revoke

post - /files.revokePublicURL
200 - Typical success response
{
  "file": {
    "channels": [
      {},
      {},
      {}
    ],
    "comments_count": 123,
    "created": 123,
    "display_as_bot": true,
    "editable": true,
    "editor": "string",
    "external_id": "string",
    "external_type": "string",
    "external_url": "string",
    "filetype": "string",
    "groups": [
      {},
      {},
      {}
    ],
    "has_rich_preview": true,
    "id": "string",
    "image_exif_rotation": 123,
    "ims": [
      {},
      {},
      {}
    ],
    "is_external": true,
    "is_public": true,
    "is_starred": true,
    "is_tombstoned": true,
    "last_editor": "string",
    "mimetype": "string",
    "mode": "string",
    "name": "string",
    "num_stars": 123,
    "original_h": 123,
    "original_w": 123,
    "permalink": "string",
    "permalink_public": "string",
    "pinned_info": {},
    "pinned_to": [
      {},
      {},
      {}
    ],
    "pretty_type": "string",
    "preview": "",
    "public_url_shared": true,
    "reactions": [
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      },
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      },
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      }
    ],
    "shares": {
      "private": "",
      "public": ""
    },
    "size": 123,
    "source_team": "string",
    "state": "string",
    "thumb_1024": "string",
    "thumb_1024_h": 123,
    "thumb_1024_w": 123,
    "thumb_160": "string",
    "thumb_360": "string",
    "thumb_360_h": 123,
    "thumb_360_w": 123,
    "thumb_480": "string",
    "thumb_480_h": 123,
    "thumb_480_w": 123,
    "thumb_64": "string",
    "thumb_720": "string",
    "thumb_720_h": 123,
    "thumb_720_w": 123,
    "thumb_80": "string",
    "thumb_800": "string",
    "thumb_800_h": 123,
    "thumb_800_w": 123,
    "thumb_960": "string",
    "thumb_960_h": 123,
    "thumb_960_w": 123,
    "timestamp": 123,
    "title": "string",
    "updated": 123,
    "url_private": "string",
    "url_private_download": "string",
    "user": "string",
    "user_team": "string",
    "username": "string"
  },
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

files sharedPublicURL


Enables a file for public/external sharing.

Parameters

  • token string

    Authentication token. Requires scope: files:write:user

  • file string

    File to share

post - /files.sharedPublicURL
200 - Typical success response
{
  "file": {
    "channels": [
      {},
      {},
      {}
    ],
    "comments_count": 123,
    "created": 123,
    "display_as_bot": true,
    "editable": true,
    "editor": "string",
    "external_id": "string",
    "external_type": "string",
    "external_url": "string",
    "filetype": "string",
    "groups": [
      {},
      {},
      {}
    ],
    "has_rich_preview": true,
    "id": "string",
    "image_exif_rotation": 123,
    "ims": [
      {},
      {},
      {}
    ],
    "is_external": true,
    "is_public": true,
    "is_starred": true,
    "is_tombstoned": true,
    "last_editor": "string",
    "mimetype": "string",
    "mode": "string",
    "name": "string",
    "num_stars": 123,
    "original_h": 123,
    "original_w": 123,
    "permalink": "string",
    "permalink_public": "string",
    "pinned_info": {},
    "pinned_to": [
      {},
      {},
      {}
    ],
    "pretty_type": "string",
    "preview": "",
    "public_url_shared": true,
    "reactions": [
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      },
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      },
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      }
    ],
    "shares": {
      "private": "",
      "public": ""
    },
    "size": 123,
    "source_team": "string",
    "state": "string",
    "thumb_1024": "string",
    "thumb_1024_h": 123,
    "thumb_1024_w": 123,
    "thumb_160": "string",
    "thumb_360": "string",
    "thumb_360_h": 123,
    "thumb_360_w": 123,
    "thumb_480": "string",
    "thumb_480_h": 123,
    "thumb_480_w": 123,
    "thumb_64": "string",
    "thumb_720": "string",
    "thumb_720_h": 123,
    "thumb_720_w": 123,
    "thumb_80": "string",
    "thumb_800": "string",
    "thumb_800_h": 123,
    "thumb_800_w": 123,
    "thumb_960": "string",
    "thumb_960_h": 123,
    "thumb_960_w": 123,
    "timestamp": 123,
    "title": "string",
    "updated": 123,
    "url_private": "string",
    "url_private_download": "string",
    "user": "string",
    "user_team": "string",
    "username": "string"
  },
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

files upload


Uploads or creates a file.

Parameters

  • channels string

    Comma-separated list of channel names or IDs where the file will be shared.

  • title string

    Title of file.

  • initial_comment string

    The message text introducing the file in specified channels.

  • filetype string

    A file type identifier.

  • filename string

    Filename of file.

  • content string

    File contents via a POST variable. If omitting this parameter, you must provide a file.

  • token string

    Authentication token. Requires scope: files:write:user

  • file string

    File contents via multipart/form-data. If omitting this parameter, you must submit content.

  • thread_ts number

    Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead.

post - /files.upload
200 - Success response after uploading a file to a channel with an initial message
{
  "file": {
    "channels": [
      {},
      {},
      {}
    ],
    "comments_count": 123,
    "created": 123,
    "display_as_bot": true,
    "editable": true,
    "editor": "string",
    "external_id": "string",
    "external_type": "string",
    "external_url": "string",
    "filetype": "string",
    "groups": [
      {},
      {},
      {}
    ],
    "has_rich_preview": true,
    "id": "string",
    "image_exif_rotation": 123,
    "ims": [
      {},
      {},
      {}
    ],
    "is_external": true,
    "is_public": true,
    "is_starred": true,
    "is_tombstoned": true,
    "last_editor": "string",
    "mimetype": "string",
    "mode": "string",
    "name": "string",
    "num_stars": 123,
    "original_h": 123,
    "original_w": 123,
    "permalink": "string",
    "permalink_public": "string",
    "pinned_info": {},
    "pinned_to": [
      {},
      {},
      {}
    ],
    "pretty_type": "string",
    "preview": "",
    "public_url_shared": true,
    "reactions": [
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      },
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      },
      {
        "count": 123,
        "name": "string",
        "users": [
          {},
          {},
          {}
        ]
      }
    ],
    "shares": {
      "private": "",
      "public": ""
    },
    "size": 123,
    "source_team": "string",
    "state": "string",
    "thumb_1024": "string",
    "thumb_1024_h": 123,
    "thumb_1024_w": 123,
    "thumb_160": "string",
    "thumb_360": "string",
    "thumb_360_h": 123,
    "thumb_360_w": 123,
    "thumb_480": "string",
    "thumb_480_h": 123,
    "thumb_480_w": 123,
    "thumb_64": "string",
    "thumb_720": "string",
    "thumb_720_h": 123,
    "thumb_720_w": 123,
    "thumb_80": "string",
    "thumb_800": "string",
    "thumb_800_h": 123,
    "thumb_800_w": 123,
    "thumb_960": "string",
    "thumb_960_h": 123,
    "thumb_960_w": 123,
    "timestamp": 123,
    "title": "string",
    "updated": 123,
    "url_private": "string",
    "url_private_download": "string",
    "user": "string",
    "user_team": "string",
    "username": "string"
  },
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups


groups archive


Archives a private channel.

Parameters

  • token string

    Authentication token. Requires scope: groups:write

  • channel string

    Private channel to archive

post - /groups.archive
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups create


Creates a private channel.

Parameters

  • validate boolean

    Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

  • token string

    Authentication token. Requires scope: groups:write

  • name string

    Name of private channel to create

post - /groups.create
200 - Typical success response
{
  "group": {
    "created": 123,
    "creator": "string",
    "id": "string",
    "is_archived": true,
    "is_deleted": true,
    "is_group": true,
    "is_moved": 123,
    "is_mpim": true,
    "is_open": true,
    "is_pending_ext_shared": true,
    "last_read": "string",
    "latest": "",
    "members": [
      {},
      {},
      {}
    ],
    "name": "string",
    "name_normalized": "string",
    "num_members": 123,
    "priority": "",
    "purpose": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "topic": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "unread_count": 123,
    "unread_count_display": 123
  },
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups createChild


Clones and archives a private channel.

Parameters

  • token string

    Authentication token. Requires scope: groups:write

  • channel string

    Private channel to clone and archive.

post - /groups.createChild
200 - Typical success response
{
  "group": {
    "created": 123,
    "creator": "string",
    "id": "string",
    "is_archived": true,
    "is_deleted": true,
    "is_group": true,
    "is_moved": 123,
    "is_mpim": true,
    "is_open": true,
    "is_pending_ext_shared": true,
    "last_read": "string",
    "latest": "",
    "members": [
      {},
      {},
      {}
    ],
    "name": "string",
    "name_normalized": "string",
    "num_members": 123,
    "priority": "",
    "purpose": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "topic": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "unread_count": 123,
    "unread_count_display": 123
  },
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups history


Fetches history of messages and events from a private channel.

Parameters

  • count integer

    Number of messages to return, between 1 and 1000.

  • unreads boolean

    Include unread_count_display in the output?

  • inclusive boolean

    Include messages with latest or oldest timestamp in results.

  • token string

    Authentication token. Requires scope: groups:history

  • oldest number

    Start of time range of messages to include in results.

  • channel string

    Private channel to fetch history for.

  • latest number

    End of time range of messages to include in results.

get - /groups.history
200 - Typical success response
{
  "has_more": true,
  "messages": [
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    },
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    },
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    }
  ],
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups info


Gets information about a private channel.

Parameters

  • token string

    Authentication token. Requires scope: groups:read

  • include_locale boolean

    Set this to true to receive the locale for this group. Defaults to false

  • channel string

    Private channel to get info on

get - /groups.info
200 - Typical success response
{
  "group": {
    "created": 123,
    "creator": "string",
    "id": "string",
    "is_archived": true,
    "is_deleted": true,
    "is_group": true,
    "is_moved": 123,
    "is_mpim": true,
    "is_open": true,
    "is_pending_ext_shared": true,
    "last_read": "string",
    "latest": "",
    "members": [
      {},
      {},
      {}
    ],
    "name": "string",
    "name_normalized": "string",
    "num_members": 123,
    "priority": "",
    "purpose": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "topic": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "unread_count": 123,
    "unread_count_display": 123
  },
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups invite


Invites a user to a private channel.

Parameters

  • token string

    Authentication token. Requires scope: groups:write

  • user string

    User to invite.

  • channel string

    Private channel to invite user to.

post - /groups.invite
200 - Typical success response
{
  "group": {
    "created": 123,
    "creator": "string",
    "id": "string",
    "is_archived": true,
    "is_deleted": true,
    "is_group": true,
    "is_moved": 123,
    "is_mpim": true,
    "is_open": true,
    "is_pending_ext_shared": true,
    "last_read": "string",
    "latest": "",
    "members": [
      {},
      {},
      {}
    ],
    "name": "string",
    "name_normalized": "string",
    "num_members": 123,
    "priority": "",
    "purpose": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "topic": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "unread_count": 123,
    "unread_count_display": 123
  },
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups kick


Removes a user from a private channel.

Parameters

  • token string

    Authentication token. Requires scope: groups:write

  • user string

    User to remove from private channel.

  • channel string

    Private channel to remove user from.

post - /groups.kick
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups leave


Leaves a private channel.

Parameters

  • token string

    Authentication token. Requires scope: groups:write

  • channel string

    Private channel to leave

post - /groups.leave
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups list


Lists private channels that the calling user has access to.

Parameters

  • cursor string

    Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.

  • exclude_members boolean

    Exclude the members from each group

  • token string

    Authentication token. Requires scope: groups:read

  • exclude_archived boolean

    Don't return archived private channels.

  • limit integer

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.

get - /groups.list
200 - Typical success response
{
  "groups": [
    {
      "created": 123,
      "creator": "string",
      "id": "string",
      "is_archived": true,
      "is_deleted": true,
      "is_group": true,
      "is_moved": 123,
      "is_mpim": true,
      "is_open": true,
      "is_pending_ext_shared": true,
      "last_read": "string",
      "latest": "",
      "members": [
        {},
        {},
        {}
      ],
      "name": "string",
      "name_normalized": "string",
      "num_members": 123,
      "priority": "",
      "purpose": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "topic": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "unread_count": 123,
      "unread_count_display": 123
    },
    {
      "created": 123,
      "creator": "string",
      "id": "string",
      "is_archived": true,
      "is_deleted": true,
      "is_group": true,
      "is_moved": 123,
      "is_mpim": true,
      "is_open": true,
      "is_pending_ext_shared": true,
      "last_read": "string",
      "latest": "",
      "members": [
        {},
        {},
        {}
      ],
      "name": "string",
      "name_normalized": "string",
      "num_members": 123,
      "priority": "",
      "purpose": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "topic": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "unread_count": 123,
      "unread_count_display": 123
    },
    {
      "created": 123,
      "creator": "string",
      "id": "string",
      "is_archived": true,
      "is_deleted": true,
      "is_group": true,
      "is_moved": 123,
      "is_mpim": true,
      "is_open": true,
      "is_pending_ext_shared": true,
      "last_read": "string",
      "latest": "",
      "members": [
        {},
        {},
        {}
      ],
      "name": "string",
      "name_normalized": "string",
      "num_members": 123,
      "priority": "",
      "purpose": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "topic": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "unread_count": 123,
      "unread_count_display": 123
    }
  ],
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups mark


Sets the read cursor in a private channel.

Parameters

  • token string

    Authentication token. Requires scope: groups:write

  • ts number

    Timestamp of the most recently seen message.

  • channel string

    Private channel to set reading cursor in.

post - /groups.mark
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups open


Opens a private channel.

Parameters

  • token string

    Authentication token. Requires scope: groups:write

  • channel string

    Private channel to open.

post - /groups.open
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups rename


Renames a private channel.

Parameters

  • validate boolean

    Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

  • token string

    Authentication token. Requires scope: groups:write

  • name string

    New name for private channel.

  • channel string

    Private channel to rename

post - /groups.rename
200 - Typical success response
{
  "channel": {
    "created": 123,
    "creator": "string",
    "id": "string",
    "is_archived": true,
    "is_deleted": true,
    "is_group": true,
    "is_moved": 123,
    "is_mpim": true,
    "is_open": true,
    "is_pending_ext_shared": true,
    "last_read": "string",
    "latest": "",
    "members": [
      {},
      {},
      {}
    ],
    "name": "string",
    "name_normalized": "string",
    "num_members": 123,
    "priority": "",
    "purpose": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "topic": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "unread_count": 123,
    "unread_count_display": 123
  },
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups replies


Retrieve a thread of messages posted to a private channel

Parameters

  • thread_ts number

    Unique identifier of a thread's parent message

  • token string

    Authentication token. Requires scope: groups:history

  • channel string

    Private channel to fetch thread from

get - /groups.replies
200 - Typical success response
{
  "has_more": true,
  "messages": [
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    },
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    },
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    }
  ],
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups setPurpose


Sets the purpose for a private channel.

Parameters

  • token string

    Authentication token. Requires scope: groups:write

  • purpose string

    The new purpose

  • channel string

    Private channel to set the purpose of

post - /groups.setPurpose
200 - Typical success response
{
  "ok": true,
  "purpose": "string"
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups setTopic


Sets the topic for a private channel.

Parameters

  • topic string

    The new topic

  • token string

    Authentication token. Requires scope: groups:write

  • channel string

    Private channel to set the topic of

post - /groups.setTopic
200 - Typical success response
{
  "ok": true,
  "topic": "string"
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

groups unarchive


Unarchives a private channel.

Parameters

  • token string

    Authentication token. Requires scope: groups:write

  • channel string

    Private channel to unarchive

post - /groups.unarchive
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

im


im close


Close a direct message channel.

post - /im.close
200 - Typical success response
{
  "already_closed": true,
  "no_op": true,
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

im history


Fetches history of messages and events from direct message channel.

Parameters

  • count integer

    Number of messages to return, between 1 and 1000.

  • unreads boolean

    Include unread_count_display in the output?

  • inclusive boolean

    Include messages with latest or oldest timestamp in results.

  • token string

    Authentication token. Requires scope: im:history

  • oldest number

    Start of time range of messages to include in results.

  • channel string

    Direct message channel to fetch history for.

  • latest number

    End of time range of messages to include in results.

get - /im.history
200 - Typical success response
{
  "has_more": true,
  "messages": [
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    },
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    },
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    }
  ],
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "needed": "string",
  "ok": true,
  "provided": "string"
}

im list


Lists direct message channels for the calling user.

Parameters

  • cursor string

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.

  • token string

    Authentication token. Requires scope: im:read

  • limit integer

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.

get - /im.list
200 - Typical success response
{
  "ims": [
    {
      "created": 123,
      "id": "string",
      "is_app_home": true,
      "is_ext_shared": true,
      "is_im": true,
      "is_org_shared": true,
      "is_shared": true,
      "is_user_deleted": true,
      "priority": "",
      "user": "string"
    },
    {
      "created": 123,
      "id": "string",
      "is_app_home": true,
      "is_ext_shared": true,
      "is_im": true,
      "is_org_shared": true,
      "is_shared": true,
      "is_user_deleted": true,
      "priority": "",
      "user": "string"
    },
    {
      "created": 123,
      "id": "string",
      "is_app_home": true,
      "is_ext_shared": true,
      "is_im": true,
      "is_org_shared": true,
      "is_shared": true,
      "is_user_deleted": true,
      "priority": "",
      "user": "string"
    }
  ],
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

im mark


Sets the read cursor in a direct message channel.

Parameters

  • token string

    Authentication token. Requires scope: im:write

  • channel string

    Direct message channel to set reading cursor in.

  • ts number

    Timestamp of the most recently seen message.

post - /im.mark
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

im open


Opens a direct message channel.

Parameters

  • token string

    Authentication token. Requires scope: im:write

  • return_im boolean

    Boolean, indicates you want the full IM channel definition in the response.

  • user string

    User to open a direct message channel with.

  • include_locale boolean

    Set this to true to receive the locale for this im. Defaults to false

post - /im.open
200 - Typical success response
{
  "already_open": true,
  "channel": {
    "created": "string",
    "id": "string",
    "is_im": true,
    "is_open": true,
    "last_read": "string",
    "latest": {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    },
    "unread_count": "",
    "unread_count_display": "",
    "user": "string"
  },
  "no_op": true,
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

im replies


Retrieve a thread of messages posted to a direct message conversation

Parameters

  • thread_ts number

    Unique identifier of a thread's parent message

  • token string

    Authentication token. Requires scope: im:history

  • channel string

    Direct message channel to fetch thread from

get - /im.replies
200 - Typical success response
{
  "has_more": true,
  "messages": [
    {},
    {},
    {}
  ],
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

migration


migration exchange


For Enterprise Grid workspaces, map local user IDs to global user IDs

get - /migration.exchange
200 - Typical success response when mappings exist for the specified user IDs
{
  "enterprise_id": "string",
  "invalid_user_ids": [
    {},
    {},
    {}
  ],
  "ok": true,
  "team_id": "string",
  "user_id_map": {}
}
default - Typical error response when there are no mappings to provide
{
  "error": "string",
  "ok": true
}

mpim


mpim close


Closes a multiparty direct message channel.

Parameters

  • token string

    Authentication token. Requires scope: mpim:write

  • channel string

    MPIM to close.

post - /mpim.close
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

mpim history


Fetches history of messages and events from a multiparty direct message.

Parameters

  • count integer

    Number of messages to return, between 1 and 1000.

  • unreads boolean

    Include unread_count_display in the output?

  • inclusive boolean

    Include messages with latest or oldest timestamp in results.

  • token string

    Authentication token. Requires scope: mpim:history

  • oldest number

    Start of time range of messages to include in results.

  • channel string

    Multiparty direct message to fetch history for.

  • latest number

    End of time range of messages to include in results.

get - /mpim.history
200 - Typical success response
{
  "has_more": true,
  "messages": [
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    },
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    },
    {
      "attachments": [
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        },
        {
          "fallback": "string",
          "id": 123,
          "image_bytes": 123,
          "image_height": 123,
          "image_url": "string",
          "image_width": 123
        }
      ],
      "blocks": [
        {
          "type": "string"
        },
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "bot_id": "",
      "client_msg_id": "string",
      "comment": {
        "comment": "string",
        "created": 123,
        "id": "string",
        "is_intro": true,
        "is_starred": true,
        "num_stars": 123,
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "timestamp": 123,
        "user": "string"
      },
      "display_as_bot": true,
      "file": {
        "channels": [
          {},
          {},
          {}
        ],
        "comments_count": 123,
        "created": 123,
        "display_as_bot": true,
        "editable": true,
        "editor": "string",
        "external_id": "string",
        "external_type": "string",
        "external_url": "string",
        "filetype": "string",
        "groups": [
          {},
          {},
          {}
        ],
        "has_rich_preview": true,
        "id": "string",
        "image_exif_rotation": 123,
        "ims": [
          {},
          {},
          {}
        ],
        "is_external": true,
        "is_public": true,
        "is_starred": true,
        "is_tombstoned": true,
        "last_editor": "string",
        "mimetype": "string",
        "mode": "string",
        "name": "string",
        "num_stars": 123,
        "original_h": 123,
        "original_w": 123,
        "permalink": "string",
        "permalink_public": "string",
        "pinned_info": {},
        "pinned_to": [
          {},
          {},
          {}
        ],
        "pretty_type": "string",
        "preview": "",
        "public_url_shared": true,
        "reactions": [
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          },
          {
            "count": 123,
            "name": "string",
            "users": [
              {},
              {},
              {}
            ]
          }
        ],
        "shares": {
          "private": "",
          "public": ""
        },
        "size": 123,
        "source_team": "string",
        "state": "string",
        "thumb_1024": "string",
        "thumb_1024_h": 123,
        "thumb_1024_w": 123,
        "thumb_160": "string",
        "thumb_360": "string",
        "thumb_360_h": 123,
        "thumb_360_w": 123,
        "thumb_480": "string",
        "thumb_480_h": 123,
        "thumb_480_w": 123,
        "thumb_64": "string",
        "thumb_720": "string",
        "thumb_720_h": 123,
        "thumb_720_w": 123,
        "thumb_80": "string",
        "thumb_800": "string",
        "thumb_800_h": 123,
        "thumb_800_w": 123,
        "thumb_960": "string",
        "thumb_960_h": 123,
        "thumb_960_w": 123,
        "timestamp": 123,
        "title": "string",
        "updated": 123,
        "url_private": "string",
        "url_private_download": "string",
        "user": "string",
        "user_team": "string",
        "username": "string"
      },
      "files": [
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        },
        {
          "channels": [
            {},
            {},
            {}
          ],
          "comments_count": 123,
          "created": 123,
          "display_as_bot": true,
          "editable": true,
          "editor": "string",
          "external_id": "string",
          "external_type": "string",
          "external_url": "string",
          "filetype": "string",
          "groups": [
            {},
            {},
            {}
          ],
          "has_rich_preview": true,
          "id": "string",
          "image_exif_rotation": 123,
          "ims": [
            {},
            {},
            {}
          ],
          "is_external": true,
          "is_public": true,
          "is_starred": true,
          "is_tombstoned": true,
          "last_editor": "string",
          "mimetype": "string",
          "mode": "string",
          "name": "string",
          "num_stars": 123,
          "original_h": 123,
          "original_w": 123,
          "permalink": "string",
          "permalink_public": "string",
          "pinned_info": {},
          "pinned_to": [
            {},
            {},
            {}
          ],
          "pretty_type": "string",
          "preview": "",
          "public_url_shared": true,
          "reactions": [
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            },
            {
              "count": 123,
              "name": "string",
              "users": [
                {},
                {},
                {}
              ]
            }
          ],
          "shares": {
            "private": "",
            "public": ""
          },
          "size": 123,
          "source_team": "string",
          "state": "string",
          "thumb_1024": "string",
          "thumb_1024_h": 123,
          "thumb_1024_w": 123,
          "thumb_160": "string",
          "thumb_360": "string",
          "thumb_360_h": 123,
          "thumb_360_w": 123,
          "thumb_480": "string",
          "thumb_480_h": 123,
          "thumb_480_w": 123,
          "thumb_64": "string",
          "thumb_720": "string",
          "thumb_720_h": 123,
          "thumb_720_w": 123,
          "thumb_80": "string",
          "thumb_800": "string",
          "thumb_800_h": 123,
          "thumb_800_w": 123,
          "thumb_960": "string",
          "thumb_960_h": 123,
          "thumb_960_w": 123,
          "timestamp": 123,
          "title": "string",
          "updated": 123,
          "url_private": "string",
          "url_private_download": "string",
          "user": "string",
          "user_team": "string",
          "username": "string"
        }
      ],
      "icons": {
        "emoji": "string"
      },
      "inviter": "string",
      "is_delayed_message": true,
      "is_intro": true,
      "is_starred": true,
      "last_read": "string",
      "latest_reply": "string",
      "name": "string",
      "old_name": "string",
      "parent_user_id": "string",
      "permalink": "string",
      "pinned_to": [
        {},
        {},
        {}
      ],
      "purpose": "string",
      "reactions": [
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        },
        {
          "count": 123,
          "name": "string",
          "users": [
            {},
            {},
            {}
          ]
        }
      ],
      "replies": [
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        },
        {
          "ts": "string",
          "user": "string"
        }
      ],
      "reply_count": 123,
      "reply_users": [
        {},
        {},
        {}
      ],
      "reply_users_count": 123,
      "source_team": "string",
      "subscribed": true,
      "subtype": "string",
      "team": "string",
      "text": "string",
      "thread_ts": "string",
      "topic": "string",
      "ts": "string",
      "type": "string",
      "unread_count": 123,
      "upload": true,
      "user": "string",
      "user_profile": {
        "avatar_hash": "string",
        "display_name": "string",
        "first_name": "string",
        "image_72": "string",
        "is_restricted": true,
        "is_ultra_restricted": true,
        "name": "string",
        "real_name": "string",
        "team": "string"
      },
      "user_team": "string",
      "username": "string"
    }
  ],
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

mpim list


Lists multiparty direct message channels for the calling user.

Parameters

  • cursor string

    Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.

  • token string

    Authentication token. Requires scope: mpim:read

  • limit integer

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.

get - /mpim.list
200 - Typical success response
{
  "groups": [
    {
      "created": 123,
      "creator": "string",
      "id": "string",
      "is_archived": true,
      "is_deleted": true,
      "is_group": true,
      "is_moved": 123,
      "is_mpim": true,
      "is_open": true,
      "is_pending_ext_shared": true,
      "last_read": "string",
      "latest": "",
      "members": [
        {},
        {},
        {}
      ],
      "name": "string",
      "name_normalized": "string",
      "num_members": 123,
      "priority": "",
      "purpose": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "topic": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "unread_count": 123,
      "unread_count_display": 123
    },
    {
      "created": 123,
      "creator": "string",
      "id": "string",
      "is_archived": true,
      "is_deleted": true,
      "is_group": true,
      "is_moved": 123,
      "is_mpim": true,
      "is_open": true,
      "is_pending_ext_shared": true,
      "last_read": "string",
      "latest": "",
      "members": [
        {},
        {},
        {}
      ],
      "name": "string",
      "name_normalized": "string",
      "num_members": 123,
      "priority": "",
      "purpose": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "topic": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "unread_count": 123,
      "unread_count_display": 123
    },
    {
      "created": 123,
      "creator": "string",
      "id": "string",
      "is_archived": true,
      "is_deleted": true,
      "is_group": true,
      "is_moved": 123,
      "is_mpim": true,
      "is_open": true,
      "is_pending_ext_shared": true,
      "last_read": "string",
      "latest": "",
      "members": [
        {},
        {},
        {}
      ],
      "name": "string",
      "name_normalized": "string",
      "num_members": 123,
      "priority": "",
      "purpose": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "topic": {
        "creator": "string",
        "last_set": 123,
        "value": "string"
      },
      "unread_count": 123,
      "unread_count_display": 123
    }
  ],
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

mpim mark


Sets the read cursor in a multiparty direct message channel.

Parameters

  • token string

    Authentication token. Requires scope: mpim:write

  • ts number

    Timestamp of the most recently seen message.

  • channel string

    multiparty direct message channel to set reading cursor in.

post - /mpim.mark
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

mpim open


This method opens a multiparty direct message.

Parameters

  • token string

    Authentication token. Requires scope: mpim:write

  • users string

    Comma separated lists of users. The ordering of the users is preserved whenever a MPIM group is returned.

post - /mpim.open
200 - Typical success response
{
  "group": {
    "created": 123,
    "creator": "string",
    "id": "string",
    "is_archived": true,
    "is_deleted": true,
    "is_group": true,
    "is_moved": 123,
    "is_mpim": true,
    "is_open": true,
    "is_pending_ext_shared": true,
    "last_read": "string",
    "latest": "",
    "members": [
      {},
      {},
      {}
    ],
    "name": "string",
    "name_normalized": "string",
    "num_members": 123,
    "priority": "",
    "purpose": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "topic": {
      "creator": "string",
      "last_set": 123,
      "value": "string"
    },
    "unread_count": 123,
    "unread_count_display": 123
  },
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

mpim replies


Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.

Parameters

  • thread_ts number

    Unique identifier of a thread's parent message.

  • token string

    Authentication token. Requires scope: mpim:history

  • channel string

    Multiparty direct message channel to fetch thread from.

get - /mpim.replies
200 - Typical success response
{
  "has_more": true,
  "messages": [
    {},
    {},
    {}
  ],
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

oauth


oauth access


Exchanges a temporary OAuth verifier code for an access token.

Parameters

  • code string

    The code param returned via the OAuth callback.

  • redirect_uri string

    This must match the originally submitted URI (if one was sent).

  • client_id string

    Issued when you created your application.

  • client_secret string

    Issued when you created your application.

  • single_channel boolean

    Request the user to add your app only to a single channel.

get - /oauth.access
200 - Successful user token negotiation for a single scope
{
  "ok": true
}
default - Typical error response
{
  "ok": true
}

oauth token


Exchanges a temporary OAuth verifier code for a workspace token.

Parameters

  • client_secret string

    Issued when you created your application.

  • code string

    The code param returned via the OAuth callback.

  • single_channel boolean

    Request the user to add your app only to a single channel.

  • client_id string

    Issued when you created your application.

  • redirect_uri string

    This must match the originally submitted URI (if one was sent).

get - /oauth.token
200 - Success example using a workspace app produces a very different kind of response
{
  "ok": true
}
default - Typical error response
{
  "ok": true
}

pins


pins add


Pins an item to a channel.

Parameters

  • file_comment string

    File comment to pin.

  • timestamp number

    Timestamp of the message to pin.

  • token string

    Authentication token. Requires scope: pins:write

  • file string

    File to pin.

  • channel string

    Channel to pin the item in.

post - /pins.add
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

pins list


Lists items pinned to a channel.

Parameters

  • token string

    Authentication token. Requires scope: pins:read

  • channel string

    Channel to get pinned items for.

get - /pins.list
200 - Typical success response
{}
default - Typical error response
{
  "error": "string",
  "ok": true
}

pins remove


Un-pins an item from a channel.

Parameters

  • file_comment string

    File comment to un-pin.

  • timestamp number

    Timestamp of the message to un-pin.

  • token string

    Authentication token. Requires scope: pins:write

  • file string

    File to un-pin.

  • channel string

    Channel where the item is pinned to.

post - /pins.remove
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

reactions


reactions add


Adds a reaction to an item.

Parameters

  • name string

    Reaction (emoji) name.

  • file_comment string

    File comment to add reaction to. Now that file threads work the way you'd expect, this argument is deprecated. Specify the timestamp and channel of the message associated with a file instead.

  • timestamp number

    Timestamp of the message to add reaction to.

  • token string

    Authentication token. Requires scope: reactions:write

  • file string

    File to add reaction to. Now that file threads work the way you'd expect, this argument is deprecated. Specify the timestamp and channel of the message associated with a file instead.

  • channel string

    Channel where the message to add reaction to was posted.

post - /reactions.add
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

reactions get


Gets reactions for an item.

Parameters

  • full boolean

    If true always return the complete reaction list.

  • file_comment string

    File comment to get reactions for.

  • timestamp number

    Timestamp of the message to get reactions for.

  • token string

    Authentication token. Requires scope: reactions:read

  • file string

    File to get reactions for.

  • channel string

    Channel where the message to get reactions for was posted.

get - /reactions.get
200 - Typical success response
{}
default - Typical error response
{
  "error": "string",
  "ok": true
}

reactions list


Lists reactions made by a user.

Parameters

  • count string
  • full boolean

    If true always return the complete reaction list.

  • cursor string

    Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.

  • token string

    Authentication token. Requires scope: reactions:read

  • limit integer

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.

  • user string

    Show reactions made by this user. Defaults to the authed user.

  • page string
get - /reactions.list
200 - Typical success response
{
  "items": [
    {},
    {},
    {}
  ],
  "ok": true,
  "paging": {
    "count": 123,
    "page": 123,
    "pages": 123,
    "per_page": 123,
    "spill": 123,
    "total": 123
  },
  "response_metadata": {
    "next_cursor": "string"
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

reactions remove


Removes a reaction from an item.

Parameters

  • name string

    Reaction (emoji) name.

  • file_comment string

    File comment to remove reaction from.

  • timestamp number

    Timestamp of the message to remove reaction from.

  • token string

    Authentication token. Requires scope: reactions:write

  • file string

    File to remove reaction from.

  • channel string

    Channel where the message to remove reaction from was posted.

post - /reactions.remove
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

reminders


reminders add


Creates a reminder.

Parameters

  • text string

    The content of the reminder

  • token string

    Authentication token. Requires scope: reminders:write

  • user string

    The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.

  • time string

    When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday")

post - /reminders.add
200 - Typical success response
{
  "ok": true,
  "reminder": {
    "complete_ts": 123,
    "creator": "string",
    "id": "string",
    "recurring": true,
    "text": "string",
    "time": 123,
    "user": "string"
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

reminders complete


Marks a reminder as complete.

Parameters

  • token string

    Authentication token. Requires scope: reminders:write

  • reminder string

    The ID of the reminder to be marked as complete

post - /reminders.complete
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

reminders delete


Deletes a reminder.

Parameters

  • token string

    Authentication token. Requires scope: reminders:write

  • reminder string

    The ID of the reminder

post - /reminders.delete
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

reminders info


Gets information about a reminder.

Parameters

  • token string

    Authentication token. Requires scope: reminders:read

  • reminder string

    The ID of the reminder

get - /reminders.info
200 - Typical success response
{
  "ok": true,
  "reminder": {
    "complete_ts": 123,
    "creator": "string",
    "id": "string",
    "recurring": true,
    "text": "string",
    "time": 123,
    "user": "string"
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

reminders list


Lists all reminders created by or for a given user.

Parameters

  • token string

    Authentication token. Requires scope: reminders:read

get - /reminders.list
200 - Typical success response
{
  "ok": true,
  "reminders": [
    {
      "complete_ts": 123,
      "creator": "string",
      "id": "string",
      "recurring": true,
      "text": "string",
      "time": 123,
      "user": "string"
    },
    {
      "complete_ts": 123,
      "creator": "string",
      "id": "string",
      "recurring": true,
      "text": "string",
      "time": 123,
      "user": "string"
    },
    {
      "complete_ts": 123,
      "creator": "string",
      "id": "string",
      "recurring": true,
      "text": "string",
      "time": 123,
      "user": "string"
    }
  ]
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

rtm


rtm connect


Starts a Real Time Messaging session.

Parameters

  • presence_sub boolean

    Only deliver presence events when requested by subscription. See presence subscriptions.

  • token string

    Authentication token. Requires scope: rtm:stream

  • batch_presence_aware boolean

    Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.

get - /rtm.connect
200 - Typical success response
{
  "ok": true,
  "self": {
    "id": "string",
    "name": "string"
  },
  "team": {
    "domain": "string",
    "id": "string",
    "name": "string"
  },
  "url": "string"
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

search messages


Searches for messages matching a query.

Parameters

  • sort_dir string

    Change sort direction to ascending (asc) or descending (desc).

  • query string

    Search query.

  • sort string

    Return matches sorted by either score or timestamp.

  • count string

    Pass the number of results you want per "page". Maximum of 100.

  • token string

    Authentication token. Requires scope: search:read

  • highlight boolean

    Pass a value of true to enable query highlight markers (see below).

  • page string
get - /search.messages
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "ok": true
}

stars


stars add


Adds a star to an item.

Parameters

  • file_comment string

    File comment to add star to.

  • timestamp number

    Timestamp of the message to add star to.

  • token string

    Authentication token. Requires scope: stars:write

  • channel string

    Channel to add star to, or channel where the message to add star to was posted (used with timestamp).

  • file string

    File to add star to.

post - /stars.add
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

stars list


Lists stars for a user.

Parameters

  • count string
  • cursor string

    Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.

  • token string

    Authentication token. Requires scope: stars:read

  • limit integer

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.

  • page string
get - /stars.list
200 - Typical success response
{
  "items": [
    {},
    {},
    {}
  ],
  "ok": true,
  "paging": {
    "count": 123,
    "page": 123,
    "pages": 123,
    "per_page": 123,
    "spill": 123,
    "total": 123
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

stars remove


Removes a star from an item.

Parameters

  • file_comment string

    File comment to remove star from.

  • timestamp number

    Timestamp of the message to remove star from.

  • token string

    Authentication token. Requires scope: stars:write

  • channel string

    Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).

  • file string

    File to remove star from.

post - /stars.remove
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

team


team accessLogs


Gets the access logs for the current team.

Parameters

  • count string
  • token string

    Authentication token. Requires scope: admin

  • page string
  • before integer

    End of time range of logs to include in results (inclusive).

get - /team.accessLogs
200 - This response demonstrates pagination and two access log entries.
{
  "logins": [
    {
      "count": 123,
      "country": "string",
      "date_first": 123,
      "date_last": 123,
      "ip": "string",
      "isp": "string",
      "region": "string",
      "user_agent": "string",
      "user_id": "string",
      "username": "string"
    },
    {
      "count": 123,
      "country": "string",
      "date_first": 123,
      "date_last": 123,
      "ip": "string",
      "isp": "string",
      "region": "string",
      "user_agent": "string",
      "user_id": "string",
      "username": "string"
    },
    {
      "count": 123,
      "country": "string",
      "date_first": 123,
      "date_last": 123,
      "ip": "string",
      "isp": "string",
      "region": "string",
      "user_agent": "string",
      "user_id": "string",
      "username": "string"
    }
  ],
  "ok": true,
  "paging": {
    "count": 123,
    "page": 123,
    "pages": 123,
    "per_page": 123,
    "spill": 123,
    "total": 123
  }
}
default - A workspace must be on a paid plan to use this method, otherwise the `paid_only` error is thrown:
{
  "error": "string",
  "ok": true
}

team billableInfo


Gets billable users information for the current team.

get - /team.billableInfo
200 - Typical success response
{
  "billable_info": {},
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

team info


Gets information about the current team.

Parameters

  • token string

    Authentication token. Requires scope: team:read

  • team string

    Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels

get - /team.info
200 - Typical success response
{
  "ok": true,
  "team": {
    "archived": true,
    "avatar_base_url": "string",
    "created": 123,
    "date_create": 123,
    "deleted": true,
    "description": "string",
    "discoverable": "string",
    "domain": "string",
    "email_domain": "string",
    "enterprise_id": "string",
    "enterprise_name": "string",
    "has_compliance_export": true,
    "icon": {
      "image_102": "string",
      "image_132": "string",
      "image_230": "string",
      "image_34": "string",
      "image_44": "string",
      "image_68": "string",
      "image_88": "string",
      "image_default": true
    },
    "id": "string",
    "is_assigned": true,
    "is_enterprise": 123,
    "limit_ts": 123,
    "messages_count": 123,
    "msg_edit_window_mins": 123,
    "name": "string",
    "over_integrations_limit": true,
    "over_storage_limit": true,
    "plan": "string"
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

team integrationLogs


Gets the integration logs for the current team.

Parameters

  • count string
  • change_type string

    Filter logs with this change type. Defaults to all logs.

  • app_id integer

    Filter logs to this Slack app. Defaults to all logs.

  • token string

    Authentication token. Requires scope: admin

  • user string

    Filter logs generated by this user’s actions. Defaults to all logs.

  • service_id integer

    Filter logs to this service. Defaults to all logs.

  • page string
get - /team.integrationLogs
200 - Typical success response
{
  "logs": [
    {
      "admin_app_id": "string",
      "app_id": "string",
      "app_type": "string",
      "change_type": "string",
      "channel": "string",
      "date": "string",
      "scope": "string",
      "service_id": "string",
      "service_type": "string",
      "user_id": "string",
      "user_name": "string"
    },
    {
      "admin_app_id": "string",
      "app_id": "string",
      "app_type": "string",
      "change_type": "string",
      "channel": "string",
      "date": "string",
      "scope": "string",
      "service_id": "string",
      "service_type": "string",
      "user_id": "string",
      "user_name": "string"
    },
    {
      "admin_app_id": "string",
      "app_id": "string",
      "app_type": "string",
      "change_type": "string",
      "channel": "string",
      "date": "string",
      "scope": "string",
      "service_id": "string",
      "service_type": "string",
      "user_id": "string",
      "user_name": "string"
    }
  ],
  "ok": true,
  "paging": {
    "count": 123,
    "page": 123,
    "pages": 123,
    "per_page": 123,
    "spill": 123,
    "total": 123
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

team profile get


Retrieve a team's profile.

Parameters

  • token string

    Authentication token. Requires scope: users.profile:read

  • visibility string

    Filter by visibility.

get - /team.profile.get
200 - Typical success response
{
  "ok": true,
  "profile": {
    "fields": [
      {
        "field_name": "string",
        "hint": "string",
        "id": "string",
        "is_hidden": true,
        "label": "string",
        "options": [
          {},
          {},
          {}
        ],
        "ordering": "",
        "possible_values": [
          {},
          {},
          {}
        ],
        "type": "string"
      },
      {
        "field_name": "string",
        "hint": "string",
        "id": "string",
        "is_hidden": true,
        "label": "string",
        "options": [
          {},
          {},
          {}
        ],
        "ordering": "",
        "possible_values": [
          {},
          {},
          {}
        ],
        "type": "string"
      },
      {
        "field_name": "string",
        "hint": "string",
        "id": "string",
        "is_hidden": true,
        "label": "string",
        "options": [
          {},
          {},
          {}
        ],
        "ordering": "",
        "possible_values": [
          {},
          {},
          {}
        ],
        "type": "string"
      }
    ]
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

usergroups


usergroups create


Create a User Group

Parameters

  • handle string

    A mention handle. Must be unique among channels, users and User Groups.

  • description string

    A short description of the User Group.

  • channels string

    A comma separated string of encoded channel IDs for which the User Group uses as a default.

  • token string

    Authentication token. Requires scope: usergroups:write

  • include_count boolean

    Include the number of users in each User Group.

  • name string

    A name for the User Group. Must be unique among User Groups.

post - /usergroups.create
200 - Typical success response
{
  "ok": true,
  "usergroup": {
    "auto_provision": true,
    "auto_type": "",
    "created_by": "string",
    "date_create": 123,
    "date_delete": 123,
    "date_update": 123,
    "deleted_by": "",
    "description": "string",
    "enterprise_subteam_id": "string",
    "handle": "string",
    "id": "string",
    "is_external": true,
    "is_subteam": true,
    "is_usergroup": true,
    "name": "string",
    "prefs": {
      "channels": [
        {},
        {},
        {}
      ],
      "groups": [
        {},
        {},
        {}
      ]
    },
    "team_id": "string",
    "updated_by": "string",
    "user_count": 123,
    "users": [
      {},
      {},
      {}
    ]
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

usergroups disable


Disable an existing User Group

Parameters

  • token string

    Authentication token. Requires scope: usergroups:write

  • include_count boolean

    Include the number of users in the User Group.

  • usergroup string

    The encoded ID of the User Group to disable.

post - /usergroups.disable
200 - Typical success response
{
  "ok": true,
  "usergroup": {
    "auto_provision": true,
    "auto_type": "",
    "created_by": "string",
    "date_create": 123,
    "date_delete": 123,
    "date_update": 123,
    "deleted_by": "",
    "description": "string",
    "enterprise_subteam_id": "string",
    "handle": "string",
    "id": "string",
    "is_external": true,
    "is_subteam": true,
    "is_usergroup": true,
    "name": "string",
    "prefs": {
      "channels": [
        {},
        {},
        {}
      ],
      "groups": [
        {},
        {},
        {}
      ]
    },
    "team_id": "string",
    "updated_by": "string",
    "user_count": 123,
    "users": [
      {},
      {},
      {}
    ]
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

usergroups enable


Enable a User Group

Parameters

  • token string

    Authentication token. Requires scope: usergroups:write

  • include_count boolean

    Include the number of users in the User Group.

  • usergroup string

    The encoded ID of the User Group to enable.

post - /usergroups.enable
200 - Typical success response
{
  "ok": true,
  "usergroup": {
    "auto_provision": true,
    "auto_type": "",
    "created_by": "string",
    "date_create": 123,
    "date_delete": 123,
    "date_update": 123,
    "deleted_by": "",
    "description": "string",
    "enterprise_subteam_id": "string",
    "handle": "string",
    "id": "string",
    "is_external": true,
    "is_subteam": true,
    "is_usergroup": true,
    "name": "string",
    "prefs": {
      "channels": [
        {},
        {},
        {}
      ],
      "groups": [
        {},
        {},
        {}
      ]
    },
    "team_id": "string",
    "updated_by": "string",
    "user_count": 123,
    "users": [
      {},
      {},
      {}
    ]
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

usergroups list


List all User Groups for a team

Parameters

  • include_users boolean

    Include the list of users for each User Group.

  • token string

    Authentication token. Requires scope: usergroups:read

  • include_count boolean

    Include the number of users in each User Group.

  • include_disabled boolean

    Include disabled User Groups.

get - /usergroups.list
200 - Typical success response
{
  "ok": true,
  "usergroups": [
    {
      "auto_provision": true,
      "auto_type": "",
      "created_by": "string",
      "date_create": 123,
      "date_delete": 123,
      "date_update": 123,
      "deleted_by": "",
      "description": "string",
      "enterprise_subteam_id": "string",
      "handle": "string",
      "id": "string",
      "is_external": true,
      "is_subteam": true,
      "is_usergroup": true,
      "name": "string",
      "prefs": {
        "channels": [
          {},
          {},
          {}
        ],
        "groups": [
          {},
          {},
          {}
        ]
      },
      "team_id": "string",
      "updated_by": "string",
      "user_count": 123,
      "users": [
        {},
        {},
        {}
      ]
    },
    {
      "auto_provision": true,
      "auto_type": "",
      "created_by": "string",
      "date_create": 123,
      "date_delete": 123,
      "date_update": 123,
      "deleted_by": "",
      "description": "string",
      "enterprise_subteam_id": "string",
      "handle": "string",
      "id": "string",
      "is_external": true,
      "is_subteam": true,
      "is_usergroup": true,
      "name": "string",
      "prefs": {
        "channels": [
          {},
          {},
          {}
        ],
        "groups": [
          {},
          {},
          {}
        ]
      },
      "team_id": "string",
      "updated_by": "string",
      "user_count": 123,
      "users": [
        {},
        {},
        {}
      ]
    },
    {
      "auto_provision": true,
      "auto_type": "",
      "created_by": "string",
      "date_create": 123,
      "date_delete": 123,
      "date_update": 123,
      "deleted_by": "",
      "description": "string",
      "enterprise_subteam_id": "string",
      "handle": "string",
      "id": "string",
      "is_external": true,
      "is_subteam": true,
      "is_usergroup": true,
      "name": "string",
      "prefs": {
        "channels": [
          {},
          {},
          {}
        ],
        "groups": [
          {},
          {},
          {}
        ]
      },
      "team_id": "string",
      "updated_by": "string",
      "user_count": 123,
      "users": [
        {},
        {},
        {}
      ]
    }
  ]
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

usergroups update


Update an existing User Group

Parameters

  • handle string

    A mention handle. Must be unique among channels, users and User Groups.

  • description string

    A short description of the User Group.

  • channels string

    A comma separated string of encoded channel IDs for which the User Group uses as a default.

  • token string

    Authentication token. Requires scope: usergroups:write

  • include_count boolean

    Include the number of users in the User Group.

  • usergroup string

    The encoded ID of the User Group to update.

  • name string

    A name for the User Group. Must be unique among User Groups.

post - /usergroups.update
200 - Typical success response
{
  "ok": true,
  "usergroup": {
    "auto_provision": true,
    "auto_type": "",
    "created_by": "string",
    "date_create": 123,
    "date_delete": 123,
    "date_update": 123,
    "deleted_by": "",
    "description": "string",
    "enterprise_subteam_id": "string",
    "handle": "string",
    "id": "string",
    "is_external": true,
    "is_subteam": true,
    "is_usergroup": true,
    "name": "string",
    "prefs": {
      "channels": [
        {},
        {},
        {}
      ],
      "groups": [
        {},
        {},
        {}
      ]
    },
    "team_id": "string",
    "updated_by": "string",
    "user_count": 123,
    "users": [
      {},
      {},
      {}
    ]
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

usergroups users list


List all users in a User Group

get - /usergroups.users.list
200 - Standard success response when used with a user token
{
  "ok": true,
  "users": [
    {},
    {},
    {}
  ]
}
default - Standard failure response when used with an invalid token
{
  "error": "string",
  "ok": true
}

usergroups users update


Update the list of users for a User Group

Parameters

  • users string

    A comma separated string of encoded user IDs that represent the entire list of users for the User Group.

  • token string

    Authentication token. Requires scope: usergroups:write

  • include_count boolean

    Include the number of users in the User Group.

  • usergroup string

    The encoded ID of the User Group to update.

post - /usergroups.users.update
200 - Typical success response
{
  "ok": true,
  "usergroup": {
    "auto_provision": true,
    "auto_type": "",
    "created_by": "string",
    "date_create": 123,
    "date_delete": 123,
    "date_update": 123,
    "deleted_by": "",
    "description": "string",
    "enterprise_subteam_id": "string",
    "handle": "string",
    "id": "string",
    "is_external": true,
    "is_subteam": true,
    "is_usergroup": true,
    "name": "string",
    "prefs": {
      "channels": [
        {},
        {},
        {}
      ],
      "groups": [
        {},
        {},
        {}
      ]
    },
    "team_id": "string",
    "updated_by": "string",
    "user_count": 123,
    "users": [
      {},
      {},
      {}
    ]
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

users


users conversations


List conversations the calling user may access.

Parameters

  • cursor string

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.

  • token string

    Authentication token. Requires scope: conversations:read

  • limit integer

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.

  • user string

    Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.

  • exclude_archived boolean

    Set to true to exclude archived channels from the list

  • types string

    Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im

get - /users.conversations
200 - Typical success response with only public channels. Note how `num_members` and `is_member` are not returned like typical `conversations` objects.
{
  "channels": [
    {},
    {},
    {}
  ],
  "ok": true,
  "response_metadata": {
    "next_cursor": "string"
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

users deletePhoto


Delete the user profile photo

Parameters

  • token string

    Authentication token. Requires scope: users.profile:write

post - /users.deletePhoto
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

users getPresence


Gets user presence information.

Parameters

  • token string

    Authentication token. Requires scope: users:read

  • user string

    User to get presence info on. Defaults to the authed user.

get - /users.getPresence
200 - When requesting information for a different user, this method just returns the current presence (either `active` or `away`).
{
  "auto_away": true,
  "connection_count": 123,
  "last_activity": 123,
  "manual_away": true,
  "ok": true,
  "online": true,
  "presence": "string"
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

users identity


Get a user's identity.

Parameters

  • token string

    Authentication token. Requires scope: identity.basic

get - /users.identity
200 - You will receive at a minimum the following information:
{}
default - Typical error response
{
  "error": "string",
  "ok": true
}

users info


Gets information about a user.

Parameters

  • token string

    Authentication token. Requires scope: users:read

  • user string

    User to get info on

  • include_locale boolean

    Set this to true to receive the locale for this user. Defaults to false

get - /users.info
200 - Typical success response
{
  "ok": true,
  "user": ""
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

users list


Lists all users in a Slack team.

Parameters

  • cursor string

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.

  • token string

    Authentication token. Requires scope: users:read

  • limit integer

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.

  • include_locale boolean

    Set this to true to receive the locale for users. Defaults to false

get - /users.list
200 - Typical success response
{
  "cache_ts": 123,
  "members": [
    {},
    {},
    {}
  ],
  "ok": true,
  "response_metadata": {
    "next_cursor": "string"
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

users lookupByEmail


Find a user with an email address.

Parameters

  • token string

    Authentication token. Requires scope: users:read.email

  • email string

    An email address belonging to a user in the workspace

get - /users.lookupByEmail
200 - Typical success response
{
  "ok": true,
  "user": ""
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

users profile get


Retrieves a user's profile information.

Parameters

  • token string

    Authentication token. Requires scope: users.profile:read

  • include_labels boolean

    Include labels for each ID in custom profile fields

  • user string

    User to retrieve profile info for

get - /users.profile.get
200 - Typical success response
{
  "ok": true,
  "profile": {
    "always_active": true,
    "api_app_id": "string",
    "avatar_hash": "string",
    "bot_id": "string",
    "display_name": "string",
    "display_name_normalized": "string",
    "email": "string",
    "fields": "",
    "first_name": "string",
    "guest_channels": "string",
    "guest_expiration_ts": 123,
    "guest_invited_by": "string",
    "image_1024": "string",
    "image_192": "string",
    "image_24": "string",
    "image_32": "string",
    "image_48": "string",
    "image_512": "string",
    "image_72": "string",
    "image_original": "string",
    "is_custom_image": true,
    "last_name": "string",
    "phone": "string",
    "real_name": "string",
    "real_name_normalized": "string",
    "skype": "string",
    "status_emoji": "string",
    "status_expiration": 123,
    "status_text": "string",
    "status_text_canonical": "string",
    "team": "string",
    "teams": "string",
    "title": "string"
  }
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

users profile set


Set the profile information for a user.

Parameters

  • profile string

    Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.

  • token string

    Authentication token. Requires scope: users.profile:write

  • user string

    ID of user to change. This argument may only be specified by team admins on paid teams.

  • value string

    Value to set a single key to. Usable only if profile is not passed.

  • name string

    Name of a single key to set. Usable only if profile is not passed.

post - /users.profile.set
200 - Typical success response
{
  "ok": true,
  "profile": {
    "always_active": true,
    "api_app_id": "string",
    "avatar_hash": "string",
    "bot_id": "string",
    "display_name": "string",
    "display_name_normalized": "string",
    "email": "string",
    "fields": "",
    "first_name": "string",
    "guest_channels": "string",
    "guest_expiration_ts": 123,
    "guest_invited_by": "string",
    "image_1024": "string",
    "image_192": "string",
    "image_24": "string",
    "image_32": "string",
    "image_48": "string",
    "image_512": "string",
    "image_72": "string",
    "image_original": "string",
    "is_custom_image": true,
    "last_name": "string",
    "phone": "string",
    "real_name": "string",
    "real_name_normalized": "string",
    "skype": "string",
    "status_emoji": "string",
    "status_expiration": 123,
    "status_text": "string",
    "status_text_canonical": "string",
    "team": "string",
    "teams": "string",
    "title": "string"
  },
  "username": "string"
}
default - Typical error response
{
  "error": "string",
  "ok": true
}

users setActive


Marked a user as active. Deprecated and non-functional.

Parameters

  • token string

    Authentication token. Requires scope: users:write

post - /users.setActive
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "ok": true
}

users setPhoto


Set the user profile photo

Parameters

  • image string

    File contents via multipart/form-data.

  • crop_w integer

    Width/height of crop box (always square)

  • token string

    Authentication token. Requires scope: users.profile:write

  • crop_y integer

    Y coordinate of top-left corner of crop box

  • crop_x integer

    X coordinate of top-left corner of crop box

post - /users.setPhoto
200 - Typical success response
{
  "ok": true,
  "profile": {
    "avatar_hash": "string",
    "image_1024": "string",
    "image_192": "string",
    "image_24": "string",
    "image_32": "string",
    "image_48": "string",
    "image_512": "string",
    "image_72": "string",
    "image_original": "string"
  }
}
default - Typical error response
{
  "debug_step": "string",
  "dims": "string",
  "error": "string",
  "ok": true,
  "time_ident": 123
}

users setPresence


Manually sets user presence.

Parameters

  • token string

    Authentication token. Requires scope: users:write

  • presence string

    Either auto or away

post - /users.setPresence
200 - Typical success response
{
  "ok": true
}
default - Typical error response
{
  "error": "string",
  "ok": true
}