Skip to content

Instantly share code, notes, and snippets.

@colmdoyle

colmdoyle/collection.json

Created April 15, 2020 14:44
Show Gist options
  • Save colmdoyle/c8e93da8b042b32a5e631710492b1070 to your computer and use it in GitHub Desktop.
Save colmdoyle/c8e93da8b042b32a5e631710492b1070 to your computer and use it in GitHub Desktop.
Download ZIP
Slack API Postman Collection
Raw
collection.json
{
"info": {
"_postman_id": "8ad7e7e7-e8f3-45d7-b30b-dd5267eea583",
"name": "Slack Web API",
"description": "One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens blessed with related OAuth scopes.\n\nContact Support:\n Name: Slack developer relations",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "admin",
"item": [
{
"name": "apps",
"item": [
{
"name": "admin.apps.approve",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.apps:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.apps.approve",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.approve"
]
},
"description": "Approve an app for installation on a workspace."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.apps:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.apps.approve",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.approve"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.apps:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.apps.approve",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.approve"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.apps.approved list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.apps.approved.list?cursor=&token=&limit=&team_id=&enterprise_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.approved.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page"
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.apps:read`"
},
{
"key": "limit",
"value": "",
"description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive."
},
{
"key": "team_id",
"value": ""
},
{
"key": "enterprise_id",
"value": ""
}
]
},
"description": "List approved apps for an org or workspace."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.apps.approved.list?cursor=&token=&limit=&team_id=&enterprise_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.approved.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
},
{
"key": "enterprise_id",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.apps.approved.list?cursor=&token=&limit=&team_id=&enterprise_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.approved.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
},
{
"key": "enterprise_id",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.apps.requests list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.apps.requests.list?cursor=&token=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.requests.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page"
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.apps:read`"
},
{
"key": "limit",
"value": "",
"description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive."
},
{
"key": "team_id",
"value": ""
}
]
},
"description": "List app requests for a team/workspace."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.apps.requests.list?cursor=&token=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.requests.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.apps.requests.list?cursor=&token=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.requests.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.apps.restrict",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.apps:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.apps.restrict",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.restrict"
]
},
"description": "Restrict an app for installation on a workspace."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.apps:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.apps.restrict",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.restrict"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.apps:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.apps.restrict",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.restrict"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.apps.restricted list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.apps.restricted.list?cursor=&token=&limit=&team_id=&enterprise_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.restricted.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page"
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.apps:read`"
},
{
"key": "limit",
"value": "",
"description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive."
},
{
"key": "team_id",
"value": ""
},
{
"key": "enterprise_id",
"value": ""
}
]
},
"description": "List restricted apps for an org or workspace."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.apps.restricted.list?cursor=&token=&limit=&team_id=&enterprise_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.restricted.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
},
{
"key": "enterprise_id",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.apps.restricted.list?cursor=&token=&limit=&team_id=&enterprise_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.apps.restricted.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
},
{
"key": "enterprise_id",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {},
"_postman_isSubFolder": true
},
{
"name": "conversations",
"item": [
{
"name": "admin.conversations.set Teams",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.conversations.setTeams",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.conversations.setTeams"
]
},
"description": "Set the workspaces in an Enterprise grid org that connect to a channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.conversations.setTeams",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.conversations.setTeams"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.conversations.setTeams",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.conversations.setTeams"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {},
"_postman_isSubFolder": true
},
{
"name": "emoji",
"item": [
{
"name": "admin.emoji.add",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.add",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.add"
]
},
"description": "Add an emoji."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.add",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.add"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.add",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.add"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.emoji.add Alias",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.addAlias",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.addAlias"
]
},
"description": "Add an emoji alias."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.addAlias",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.addAlias"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.addAlias",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.addAlias"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.emoji.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page"
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:read`"
},
{
"key": "limit",
"value": "",
"description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive."
}
]
},
"description": "List emoji for an Enterprise Grid organization."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.emoji.remove",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.remove"
]
},
"description": "Remove an emoji across an Enterprise Grid organization"
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.remove"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.remove"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.emoji.rename",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.rename",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.rename"
]
},
"description": "Rename an emoji."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.rename",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.rename"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.emoji.rename",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.emoji.rename"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {},
"_postman_isSubFolder": true
},
{
"name": "inviteRequests",
"item": [
{
"name": "admin.inviteRequests.approve",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.approve",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.approve"
]
},
"description": "Approve a workspace invite request."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.approve",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.approve"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.approve",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.approve"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.inviteRequests approved list",
"request": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.approved.list?cursor=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.approved.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "Value of the `next_cursor` field sent as part of the previous API response"
},
{
"key": "limit",
"value": "",
"description": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive"
},
{
"key": "team_id",
"value": "",
"description": "ID for the workspace where the invite requests were made."
}
]
},
"description": "List all approved workspace invite requests."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.approved.list?cursor=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.approved.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.approved.list?cursor=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.approved.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.inviteRequests denied list",
"request": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.denied.list?cursor=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.denied.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "Value of the `next_cursor` field sent as part of the previous api response"
},
{
"key": "limit",
"value": "",
"description": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive"
},
{
"key": "team_id",
"value": "",
"description": "ID for the workspace where the invite requests were made."
}
]
},
"description": "List all denied workspace invite requests."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.denied.list?cursor=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.denied.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.denied.list?cursor=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.denied.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.inviteRequests deny",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.deny",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.deny"
]
},
"description": "Deny a workspace invite request."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.deny",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.deny"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.deny",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.deny"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.inviteRequests list",
"request": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.list?cursor=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "Value of the `next_cursor` field sent as part of the previous API response"
},
{
"key": "limit",
"value": "",
"description": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive"
},
{
"key": "team_id",
"value": "",
"description": "ID for the workspace where the invite requests were made."
}
]
},
"description": "List all pending workspace invite requests."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.list?cursor=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.invites:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.inviteRequests.list?cursor=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.inviteRequests.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {},
"_postman_isSubFolder": true
},
{
"name": "teams",
"item": [
{
"name": "admin.teams.admins.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.teams.admins.list?cursor=&token=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.admins.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page."
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:read`"
},
{
"key": "limit",
"value": "",
"description": "The maximum number of items to return."
},
{
"key": "team_id",
"value": "",
"description": "(Required) "
}
]
},
"description": "List all of the admins on a given workspace."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.teams.admins.list?cursor=&token=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.admins.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.teams.admins.list?cursor=&token=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.admins.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.teams.create",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.create",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.create"
]
},
"description": "Create an Enterprise team."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.create",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.create"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.create",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.create"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.teams.list",
"request": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.list?cursor=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page."
},
{
"key": "limit",
"value": "",
"description": "The maximum number of items to return. Must be between 1 - 100 both inclusive."
}
]
},
"description": "List all teams on an Enterprise organization"
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.list?cursor=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "limit",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.list?cursor=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "limit",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.teams.owners list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.teams.owners.list?cursor=&token=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.owners.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page."
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:read`"
},
{
"key": "limit",
"value": "",
"description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive."
},
{
"key": "team_id",
"value": "",
"description": "(Required) "
}
]
},
"description": "List all of the owners on a given workspace."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.teams.owners.list?cursor=&token=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.owners.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.teams.owners.list?cursor=&token=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.owners.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.teams.settings info",
"request": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.info?team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.info"
],
"query": [
{
"key": "team_id",
"value": "",
"description": "(Required) "
}
]
},
"description": "Fetch information about settings in a workspace"
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.info?team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.info"
],
"query": [
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.info?team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.info"
],
"query": [
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.teams.settings set Default Channels",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setDefaultChannels",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setDefaultChannels"
]
},
"description": "Set the default channels of a workspace."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setDefaultChannels",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setDefaultChannels"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setDefaultChannels",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setDefaultChannels"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.teams.settings set Description",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setDescription",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setDescription"
]
},
"description": "Set the description of a given workspace."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setDescription",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setDescription"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setDescription",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setDescription"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.teams.settings set Discoverability",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setDiscoverability",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setDiscoverability"
]
},
"description": "An API method that allows admins to set the discoverability of a given workspace"
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setDiscoverability",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setDiscoverability"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setDiscoverability",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setDiscoverability"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.teams.settings set Icon",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setIcon",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setIcon"
]
},
"description": "Sets the icon of a workspace."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setIcon",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setIcon"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setIcon",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setIcon"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.teams.settings set Name",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setName",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setName"
]
},
"description": "Set the name of a given workspace."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setName",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setName"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.teams:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.teams.settings.setName",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.teams.settings.setName"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {},
"_postman_isSubFolder": true
},
{
"name": "users",
"item": [
{
"name": "admin.users.assign",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.assign",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.assign"
]
},
"description": "Add an Enterprise user to a workspace."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.assign",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.assign"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.assign",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.assign"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.users.invite",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.invite",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.invite"
]
},
"description": "Invite a user to a workspace."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.invite",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.invite"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.invite",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.invite"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.users.list",
"request": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.list?cursor=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page."
},
{
"key": "limit",
"value": "",
"description": "Limit for how many users to be retrieved per page"
},
{
"key": "team_id",
"value": "",
"description": "(Required) The ID (`T1234`) of the workspace."
}
]
},
"description": "List users on a workspace"
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.list?cursor=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:read`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.list?cursor=&limit=&team_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "team_id",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.users.remove",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.remove"
]
},
"description": "Remove a user from a workspace."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.remove"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.remove"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.users.session reset",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.session.reset",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.session.reset"
]
},
"description": "Wipes all valid sessions on all devices for a given user"
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.session.reset",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.session.reset"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.session.reset",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.session.reset"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.users.set Admin",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.setAdmin",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.setAdmin"
]
},
"description": "Set an existing guest, regular user, or owner to be an admin user."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.setAdmin",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.setAdmin"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.setAdmin",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.setAdmin"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.users.set Expiration",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.setExpiration",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.setExpiration"
]
},
"description": "Set an expiration for a guest user"
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.setExpiration",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.setExpiration"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.setExpiration",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.setExpiration"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.users.set Owner",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.setOwner",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.setOwner"
]
},
"description": "Set an existing guest, regular user, or admin user to be a workspace owner."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.setOwner",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.setOwner"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.setOwner",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.setOwner"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "admin.users.set Regular",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.setRegular",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.setRegular"
]
},
"description": "Set an existing guest user, admin user, or owner to be a regular user."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.setRegular",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.setRegular"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin.users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/admin.users.setRegular",
"host": [
"{{baseUrl}}"
],
"path": [
"admin.users.setRegular"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {},
"_postman_isSubFolder": true
}
],
"protocolProfileBehavior": {}
},
{
"name": "api",
"item": [
{
"name": "api.test",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api.test?foo=&error=",
"host": [
"{{baseUrl}}"
],
"path": [
"api.test"
],
"query": [
{
"key": "foo",
"value": "",
"description": "example property to return"
},
{
"key": "error",
"value": "",
"description": "Error response to return"
}
]
},
"description": "Checks API calling code."
},
"response": [
{
"name": "Standard success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api.test?foo=&error=",
"host": [
"{{baseUrl}}"
],
"path": [
"api.test"
],
"query": [
{
"key": "foo",
"value": ""
},
{
"key": "error",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Artificial error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api.test?foo=&error=",
"host": [
"{{baseUrl}}"
],
"path": [
"api.test"
],
"query": [
{
"key": "foo",
"value": ""
},
{
"key": "error",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "apps",
"item": [
{
"name": "apps.permissions.info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.info?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.info"
],
"query": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `none`"
}
]
},
"description": "Returns list of permissions this app has on a team."
},
"response": [
{
"name": "Standard success response when used with a user token",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.info?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.info"
],
"query": [
{
"key": "token",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Standard failure response when used with an invalid token",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.info?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.info"
],
"query": [
{
"key": "token",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "apps.permissions.request",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.request?scopes=&token=&trigger_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.request"
],
"query": [
{
"key": "scopes",
"value": "",
"description": "(Required) A comma separated list of scopes to request for"
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
},
{
"key": "trigger_id",
"value": "",
"description": "(Required) Token used to trigger the permissions API"
}
]
},
"description": "Allows an app to request additional scopes"
},
"response": [
{
"name": "Standard success response when used with a user token",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.request?scopes=&token=&trigger_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.request"
],
"query": [
{
"key": "scopes",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "trigger_id",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Standard failure response when trigger_id is invalid",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.request?scopes=&token=&trigger_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.request"
],
"query": [
{
"key": "scopes",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "trigger_id",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "apps.permissions.resources list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.resources.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.resources.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more detail."
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
},
{
"key": "limit",
"value": "",
"description": "The maximum number of items to return."
}
]
},
"description": "Returns list of resource grants this app has on a team."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.resources.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.resources.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical successful paginated response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.resources.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.resources.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "apps.permissions.scopes list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.scopes.list?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.scopes.list"
],
"query": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
]
},
"description": "Returns list of scopes this app has on a team."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.scopes.list?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.scopes.list"
],
"query": [
{
"key": "token",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical successful paginated response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.scopes.list?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.scopes.list"
],
"query": [
{
"key": "token",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "apps.permissions.users list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.users.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.users.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more detail."
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
},
{
"key": "limit",
"value": "",
"description": "The maximum number of items to return."
}
]
},
"description": "Returns list of user grants and corresponding scopes this app has on a team."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.users.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.users.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical successful paginated response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.users.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.users.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "apps.permissions.users request",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.users.request?scopes=&token=&user=&trigger_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.users.request"
],
"query": [
{
"key": "scopes",
"value": "",
"description": "(Required) A comma separated list of user scopes to request for"
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
},
{
"key": "user",
"value": "",
"description": "(Required) The user this scope is being requested for"
},
{
"key": "trigger_id",
"value": "",
"description": "(Required) Token used to trigger the request"
}
]
},
"description": "Enables an app to trigger a permissions modal to grant an app access to a user access scope."
},
"response": [
{
"name": "Standard success response when used with a user token",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.users.request?scopes=&token=&user=&trigger_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.users.request"
],
"query": [
{
"key": "scopes",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
},
{
"key": "trigger_id",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Standard failure response when trigger_id is invalid",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.permissions.users.request?scopes=&token=&user=&trigger_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.permissions.users.request"
],
"query": [
{
"key": "scopes",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
},
{
"key": "trigger_id",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "apps.uninstall",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.uninstall?client_secret=&token=&client_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.uninstall"
],
"query": [
{
"key": "client_secret",
"value": "",
"description": "Issued when you created your application."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `none`"
},
{
"key": "client_id",
"value": "",
"description": "Issued when you created your application."
}
]
},
"description": "Uninstalls your app from a workspace."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.uninstall?client_secret=&token=&client_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.uninstall"
],
"query": [
{
"key": "client_secret",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "client_id",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/apps.uninstall?client_secret=&token=&client_id=",
"host": [
"{{baseUrl}}"
],
"path": [
"apps.uninstall"
],
"query": [
{
"key": "client_secret",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "client_id",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "auth",
"item": [
{
"name": "auth.revoke",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/auth.revoke?test=&token=",
"host": [
"{{baseUrl}}"
],
"path": [
"auth.revoke"
],
"query": [
{
"key": "test",
"value": "",
"description": "Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked."
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
]
},
"description": "Revokes a token."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/auth.revoke?test=&token=",
"host": [
"{{baseUrl}}"
],
"path": [
"auth.revoke"
],
"query": [
{
"key": "test",
"value": ""
},
{
"key": "token",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/auth.revoke?test=&token=",
"host": [
"{{baseUrl}}"
],
"path": [
"auth.revoke"
],
"query": [
{
"key": "test",
"value": ""
},
{
"key": "token",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "auth.test",
"request": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/auth.test",
"host": [
"{{baseUrl}}"
],
"path": [
"auth.test"
]
},
"description": "Checks authentication & identity."
},
"response": [
{
"name": "Standard failure response when used with an invalid token",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/auth.test",
"host": [
"{{baseUrl}}"
],
"path": [
"auth.test"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Standard success response when used with a user token",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/auth.test",
"host": [
"{{baseUrl}}"
],
"path": [
"auth.test"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "bots",
"item": [
{
"name": "bots.info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/bots.info?token=&bot=",
"host": [
"{{baseUrl}}"
],
"path": [
"bots.info"
],
"query": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `users:read`"
},
{
"key": "bot",
"value": "",
"description": "Bot user to get info on"
}
]
},
"description": "Gets information about a bot user."
},
"response": [
{
"name": "When no bot can be found, it returns an error.",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/bots.info?token=&bot=",
"host": [
"{{baseUrl}}"
],
"path": [
"bots.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "bot",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "When successful, returns bot info by bot ID.",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/bots.info?token=&bot=",
"host": [
"{{baseUrl}}"
],
"path": [
"bots.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "bot",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "channels",
"item": [
{
"name": "channels.archive",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.archive",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.archive"
]
},
"description": "Archives a channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.archive",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.archive"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.archive",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.archive"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.create",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.create",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.create"
]
},
"description": "Creates a channel."
},
"response": [
{
"name": "Example error response when an invalid name is provided",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.create",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.create"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response resulting in a new channel",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.create",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.create"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.history",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/channels.history?count=&unreads=&inclusive=&token=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.history"
],
"query": [
{
"key": "count",
"value": "",
"description": "Number of messages to return, between 1 and 1000."
},
{
"key": "unreads",
"value": "",
"description": "Include `unread_count_display` in the output?"
},
{
"key": "inclusive",
"value": "",
"description": "Include messages with latest or oldest timestamp in results."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:history`"
},
{
"key": "oldest",
"value": "",
"description": "Start of time range of messages to include in results."
},
{
"key": "channel",
"value": "",
"description": "Channel to fetch history for."
},
{
"key": "latest",
"value": "",
"description": "End of time range of messages to include in results."
}
]
},
"description": "Fetches history of messages and events from a channel."
},
"response": [
{
"name": "Error response when the specified channel cannot be found",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/channels.history?count=&unreads=&inclusive=&token=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.history"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "unreads",
"value": ""
},
{
"key": "inclusive",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response containing the channel's history",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/channels.history?count=&unreads=&inclusive=&token=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.history"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "unreads",
"value": ""
},
{
"key": "inclusive",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/channels.info?token=&include_locale=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.info"
],
"query": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:read`"
},
{
"key": "include_locale",
"value": "",
"description": "Set this to `true` to receive the locale for this channel. Defaults to `false`"
},
{
"key": "channel",
"value": "",
"description": "Channel to get info on"
}
]
},
"description": "Gets information about a channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/channels.info?token=&include_locale=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "include_locale",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Error response when the specified channel cannot be found",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/channels.info?token=&include_locale=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "include_locale",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.invite",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.invite",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.invite"
]
},
"description": "Invites a user to a channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.invite",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.invite"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "A somewhat typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.invite",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.invite"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.join",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.join",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.join"
]
},
"description": "Joins a channel, creating it if needed."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.join",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.join"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.join",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.join"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.kick",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.kick",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.kick"
]
},
"description": "Removes a user from a channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.kick",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.kick"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.kick",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.kick"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.leave",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.leave",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.leave"
]
},
"description": "Leaves a channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.leave",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.leave"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.leave",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.leave"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/channels.list?exclude_members=&cursor=&token=&limit=&exclude_archived=",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.list"
],
"query": [
{
"key": "exclude_members",
"value": "",
"description": "Exclude the `members` collection from each `channel`"
},
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more detail."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:read`"
},
{
"key": "limit",
"value": "",
"description": "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."
},
{
"key": "exclude_archived",
"value": "",
"description": "Exclude archived channels from the list"
}
]
},
"description": "Lists all channels in a Slack team."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/channels.list?exclude_members=&cursor=&token=&limit=&exclude_archived=",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.list"
],
"query": [
{
"key": "exclude_members",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "exclude_archived",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical cursored success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/channels.list?exclude_members=&cursor=&token=&limit=&exclude_archived=",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.list"
],
"query": [
{
"key": "exclude_members",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "exclude_archived",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.mark",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.mark",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.mark"
]
},
"description": "Sets the read cursor in a channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.mark",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.mark"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.mark",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.mark"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.rename",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.rename",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.rename"
]
},
"description": "Renames a channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.rename",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.rename"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.rename",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.rename"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.replies",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/channels.replies?thread_ts=&token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.replies"
],
"query": [
{
"key": "thread_ts",
"value": "",
"description": "Unique identifier of a thread's parent message"
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:history`"
},
{
"key": "channel",
"value": "",
"description": "Channel to fetch thread from"
}
]
},
"description": "Retrieve a thread of messages posted to a channel"
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/channels.replies?thread_ts=&token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.replies"
],
"query": [
{
"key": "thread_ts",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/channels.replies?thread_ts=&token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.replies"
],
"query": [
{
"key": "thread_ts",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.setPurpose",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.setPurpose",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.setPurpose"
]
},
"description": "Sets the purpose for a channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.setPurpose",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.setPurpose"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.setPurpose",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.setPurpose"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.setTopic",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.setTopic",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.setTopic"
]
},
"description": "Sets the topic for a channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.setTopic",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.setTopic"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.setTopic",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.setTopic"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "channels.unarchive",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.unarchive"
]
},
"description": "Unarchives a channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.unarchive"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/channels.unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"channels.unarchive"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "chat",
"item": [
{
"name": "chat.delete",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.delete",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.delete"
]
},
"description": "Deletes a message."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.delete",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.delete"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.delete",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.delete"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "chat.deleteScheduledMessage",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.deleteScheduledMessage",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.deleteScheduledMessage"
]
},
"description": "Deletes a pending scheduled message from the queue."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.deleteScheduledMessage",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.deleteScheduledMessage"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response if no message is found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.deleteScheduledMessage",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.deleteScheduledMessage"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "chat.getPermalink",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/chat.getPermalink?token=&message_ts=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.getPermalink"
],
"query": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
},
{
"key": "message_ts",
"value": "",
"description": "(Required) A message's `ts` value, uniquely identifying it within a channel"
},
{
"key": "channel",
"value": "",
"description": "(Required) The ID of the conversation or channel containing the message"
}
]
},
"description": "Retrieve a permalink URL for a specific extant message"
},
"response": [
{
"name": "Standard success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/chat.getPermalink?token=&message_ts=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.getPermalink"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "message_ts",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Error response when channel cannot be found",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/chat.getPermalink?token=&message_ts=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.getPermalink"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "message_ts",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "chat.meMessage",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `chat:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.meMessage",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.meMessage"
]
},
"description": "Share a me message into a channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `chat:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.meMessage",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.meMessage"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `chat:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.meMessage",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.meMessage"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "chat.postEphemeral",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.postEphemeral",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.postEphemeral"
]
},
"description": "Sends an ephemeral message to a user in a channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.postEphemeral",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.postEphemeral"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.postEphemeral",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.postEphemeral"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "chat.postMessage",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.postMessage",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.postMessage"
]
},
"description": "Sends a message to a channel."
},
"response": [
{
"name": "Typical error response if too many attachments are included",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.postMessage",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.postMessage"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.postMessage",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.postMessage"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "chat.scheduleMessage",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.scheduleMessage",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.scheduleMessage"
]
},
"description": "Schedules a message to be sent to a channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.scheduleMessage",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.scheduleMessage"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response if the `post_at` is invalid (ex. in the past or too far into the future)",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.scheduleMessage",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.scheduleMessage"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "chat.scheduledMessages.list",
"request": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.scheduledMessages.list?cursor=&limit=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.scheduledMessages.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "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."
},
{
"key": "limit",
"value": "",
"description": "Maximum number of original entries to return."
},
{
"key": "oldest",
"value": "",
"description": "A UNIX timestamp of the oldest value in the time range"
},
{
"key": "channel",
"value": "",
"description": "The channel of the scheduled messages"
},
{
"key": "latest",
"value": "",
"description": "A UNIX timestamp of the latest value in the time range"
}
]
},
"description": "Returns a list of scheduled messages."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.scheduledMessages.list?cursor=&limit=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.scheduledMessages.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response if the channel passed is invalid",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.scheduledMessages.list?cursor=&limit=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.scheduledMessages.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "chat.unfurl",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `links:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.unfurl",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.unfurl"
]
},
"description": "Provide custom unfurl behavior for user-posted URLs"
},
"response": [
{
"name": "Typical, minimal success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `links:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.unfurl",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.unfurl"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `links:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.unfurl",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.unfurl"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "chat.update",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.update",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.update"
]
},
"description": "Updates a message."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.update",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.update"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `chat:write`"
}
],
"url": {
"raw": "{{baseUrl}}/chat.update",
"host": [
"{{baseUrl}}"
],
"path": [
"chat.update"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "conversations",
"item": [
{
"name": "conversations.archive",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.archive",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.archive"
]
},
"description": "Archives a conversation."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.archive",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.archive"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.archive",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.archive"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.close",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.close",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.close"
]
},
"description": "Closes a direct message or multi-person direct message."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.close",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.close"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.close",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.close"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.create",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.create",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.create"
]
},
"description": "Initiates a public or private channel-based conversation"
},
"response": [
{
"name": "Typical error response when name already in use",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.create",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.create"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "If successful, the command returns a rather stark [conversation object](/types/conversation)",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.create",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.create"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.history",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.history?inclusive=&cursor=&token=&limit=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.history"
],
"query": [
{
"key": "inclusive",
"value": "",
"description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified."
},
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more detail."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:history`"
},
{
"key": "limit",
"value": "",
"description": "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."
},
{
"key": "oldest",
"value": "",
"description": "Start of time range of messages to include in results."
},
{
"key": "channel",
"value": "",
"description": "Conversation ID to fetch history for."
},
{
"key": "latest",
"value": "",
"description": "End of time range of messages to include in results."
}
]
},
"description": "Fetches a conversation's history of messages and events."
},
"response": [
{
"name": "Typical success response containing a channel's messages",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.history?inclusive=&cursor=&token=&limit=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.history"
],
"query": [
{
"key": "inclusive",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.history?inclusive=&cursor=&token=&limit=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.history"
],
"query": [
{
"key": "inclusive",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.info?include_num_members=&token=&channel=&include_locale=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.info"
],
"query": [
{
"key": "include_num_members",
"value": "",
"description": "Set to `true` to include the member count for the specified conversation. Defaults to `false`"
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:read`"
},
{
"key": "channel",
"value": "",
"description": "Conversation ID to learn more about"
},
{
"key": "include_locale",
"value": "",
"description": "Set this to `true` to receive the locale for this conversation. Defaults to `false`"
}
]
},
"description": "Retrieve information about a conversation."
},
"response": [
{
"name": "Typical error response when a channel cannot be found",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.info?include_num_members=&token=&channel=&include_locale=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.info"
],
"query": [
{
"key": "include_num_members",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "include_locale",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "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.)",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.info?include_num_members=&token=&channel=&include_locale=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.info"
],
"query": [
{
"key": "include_num_members",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "include_locale",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.invite",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.invite",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.invite"
]
},
"description": "Invites users to a channel."
},
"response": [
{
"name": "Typical error response when an invite is attempted on a conversation type that does not support it",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.invite",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.invite"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response when an invitation is extended",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.invite",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.invite"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.join",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.join",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.join"
]
},
"description": "Joins an existing conversation."
},
"response": [
{
"name": "Typical error response if the conversation is archived and cannot be joined",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.join",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.join"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `channels:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.join",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.join"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.kick",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.kick",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.kick"
]
},
"description": "Removes a user from a conversation."
},
"response": [
{
"name": "Typical error response when you attempt to kick yourself from a channel",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.kick",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.kick"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.kick",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.kick"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.leave",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.leave",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.leave"
]
},
"description": "Leaves a conversation."
},
"response": [
{
"name": "Typical error response when attempting to leave a workspace's \"general\" channel",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.leave",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.leave"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.leave",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.leave"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.list?cursor=&token=&limit=&exclude_archived=&types=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more detail."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:read`"
},
{
"key": "limit",
"value": "",
"description": "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."
},
{
"key": "exclude_archived",
"value": "",
"description": "Set to `true` to exclude archived channels from the list"
},
{
"key": "types",
"value": "",
"description": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`"
}
]
},
"description": "Lists all channels in a Slack team."
},
"response": [
{
"name": "Typical success response with only public channels",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.list?cursor=&token=&limit=&exclude_archived=&types=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "exclude_archived",
"value": ""
},
{
"key": "types",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.list?cursor=&token=&limit=&exclude_archived=&types=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "exclude_archived",
"value": ""
},
{
"key": "types",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.members",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.members?cursor=&token=&limit=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.members"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more detail."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:read`"
},
{
"key": "limit",
"value": "",
"description": "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."
},
{
"key": "channel",
"value": "",
"description": "ID of the conversation to retrieve members for"
}
]
},
"description": "Retrieve members of a conversation."
},
"response": [
{
"name": "Typical paginated success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.members?cursor=&token=&limit=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.members"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response when an invalid cursor is provided",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.members?cursor=&token=&limit=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.members"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.open",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.open",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.open"
]
},
"description": "Opens or resumes a direct message or multi-person direct message."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.open",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.open"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.open",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.open"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.rename",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.rename",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.rename"
]
},
"description": "Renames a conversation."
},
"response": [
{
"name": "Typical error response when the calling user is not a member of the conversation",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.rename",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.rename"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.rename",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.rename"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.replies",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.replies?inclusive=&ts=&cursor=&token=&limit=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.replies"
],
"query": [
{
"key": "inclusive",
"value": "",
"description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified."
},
{
"key": "ts",
"value": "",
"description": "Unique identifier of a thread's parent message."
},
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more detail."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:history`"
},
{
"key": "limit",
"value": "",
"description": "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."
},
{
"key": "oldest",
"value": "",
"description": "Start of time range of messages to include in results."
},
{
"key": "channel",
"value": "",
"description": "Conversation ID to fetch thread from."
},
{
"key": "latest",
"value": "",
"description": "End of time range of messages to include in results."
}
]
},
"description": "Retrieve a thread of messages posted to a conversation"
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.replies?inclusive=&ts=&cursor=&token=&limit=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.replies"
],
"query": [
{
"key": "inclusive",
"value": ""
},
{
"key": "ts",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/conversations.replies?inclusive=&ts=&cursor=&token=&limit=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.replies"
],
"query": [
{
"key": "inclusive",
"value": ""
},
{
"key": "ts",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.setPurpose",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.setPurpose",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.setPurpose"
]
},
"description": "Sets the purpose for a conversation."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.setPurpose",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.setPurpose"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.setPurpose",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.setPurpose"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.setTopic",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.setTopic",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.setTopic"
]
},
"description": "Sets the topic for a conversation."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.setTopic",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.setTopic"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.setTopic",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.setTopic"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "conversations.unarchive",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.unarchive"
]
},
"description": "Reverses conversation archival."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.unarchive"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:write`"
}
],
"url": {
"raw": "{{baseUrl}}/conversations.unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"conversations.unarchive"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "dialog",
"item": [
{
"name": "dialog.open",
"request": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/dialog.open?trigger_id=&dialog=",
"host": [
"{{baseUrl}}"
],
"path": [
"dialog.open"
],
"query": [
{
"key": "trigger_id",
"value": "",
"description": "(Required) Exchange a trigger to post to the user."
},
{
"key": "dialog",
"value": "",
"description": "(Required) The dialog definition. This must be a JSON-encoded string."
}
]
},
"description": "Open a dialog with a user"
},
"response": [
{
"name": "Typical error response, before getting to any possible validation errors.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/dialog.open?trigger_id=&dialog=",
"host": [
"{{baseUrl}}"
],
"path": [
"dialog.open"
],
"query": [
{
"key": "trigger_id",
"value": ""
},
{
"key": "dialog",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response is quite minimal.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/dialog.open?trigger_id=&dialog=",
"host": [
"{{baseUrl}}"
],
"path": [
"dialog.open"
],
"query": [
{
"key": "trigger_id",
"value": ""
},
{
"key": "dialog",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "dnd",
"item": [
{
"name": "dnd.endDnd",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `dnd:write`"
}
],
"url": {
"raw": "{{baseUrl}}/dnd.endDnd",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.endDnd"
]
},
"description": "Ends the current user's Do Not Disturb session immediately."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `dnd:write`"
}
],
"url": {
"raw": "{{baseUrl}}/dnd.endDnd",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.endDnd"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `dnd:write`"
}
],
"url": {
"raw": "{{baseUrl}}/dnd.endDnd",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.endDnd"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "dnd.endSnooze",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `dnd:write`"
}
],
"url": {
"raw": "{{baseUrl}}/dnd.endSnooze",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.endSnooze"
]
},
"description": "Ends the current user's snooze mode immediately."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `dnd:write`"
}
],
"url": {
"raw": "{{baseUrl}}/dnd.endSnooze",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.endSnooze"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `dnd:write`"
}
],
"url": {
"raw": "{{baseUrl}}/dnd.endSnooze",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.endSnooze"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "dnd.info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/dnd.info?token=&user=",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.info"
],
"query": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `dnd:read`"
},
{
"key": "user",
"value": "",
"description": "User to fetch status for (defaults to current user)"
}
]
},
"description": "Retrieves a user's current Do Not Disturb status."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/dnd.info?token=&user=",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/dnd.info?token=&user=",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "dnd.setSnooze",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/dnd.setSnooze",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.setSnooze"
]
},
"description": "Turns on Do Not Disturb mode for the current user, or changes its duration."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/dnd.setSnooze",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.setSnooze"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/dnd.setSnooze",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.setSnooze"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "dnd.teamInfo",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/dnd.teamInfo?token=&users=",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.teamInfo"
],
"query": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `dnd:read`"
},
{
"key": "users",
"value": "",
"description": "Comma-separated list of users to fetch Do Not Disturb status for"
}
]
},
"description": "Retrieves the Do Not Disturb status for up to 50 users on a team."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/dnd.teamInfo?token=&users=",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.teamInfo"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "users",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/dnd.teamInfo?token=&users=",
"host": [
"{{baseUrl}}"
],
"path": [
"dnd.teamInfo"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "users",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "emoji",
"item": [
{
"name": "emoji.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/emoji.list?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"emoji.list"
],
"query": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `emoji:read`"
}
]
},
"description": "Lists custom emoji for a team."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/emoji.list?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"emoji.list"
],
"query": [
{
"key": "token",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/emoji.list?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"emoji.list"
],
"query": [
{
"key": "token",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "files",
"item": [
{
"name": "remote",
"item": [
{
"name": "files.remote.add",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.add",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.add"
]
},
"description": "Adds a file from a remote service"
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.add",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.add"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.add",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.add"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "files.remote.info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.info?token=&external_id=&file=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.info"
],
"query": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `remote_files:read`"
},
{
"key": "external_id",
"value": "",
"description": "Creator defined GUID for the file."
},
{
"key": "file",
"value": "",
"description": "Specify a file by providing its ID."
}
]
},
"description": "Retrieve information about a remote file added to Slack"
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.info?token=&external_id=&file=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "external_id",
"value": ""
},
{
"key": "file",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.info?token=&external_id=&file=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "external_id",
"value": ""
},
{
"key": "file",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "files.remote.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.list?ts_to=&cursor=&ts_from=&token=&limit=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.list"
],
"query": [
{
"key": "ts_to",
"value": "",
"description": "Filter files created before this timestamp (inclusive)."
},
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more detail."
},
{
"key": "ts_from",
"value": "",
"description": "Filter files created after this timestamp (inclusive)."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `remote_files:read`"
},
{
"key": "limit",
"value": "",
"description": "The maximum number of items to return."
},
{
"key": "channel",
"value": "",
"description": "Filter files appearing in a specific channel, indicated by its ID."
}
]
},
"description": "Retrieve information about a remote file added to Slack"
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.list?ts_to=&cursor=&ts_from=&token=&limit=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.list"
],
"query": [
{
"key": "ts_to",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "ts_from",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.list?ts_to=&cursor=&ts_from=&token=&limit=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.list"
],
"query": [
{
"key": "ts_to",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "ts_from",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "files.remote.remove",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.remove"
]
},
"description": "Remove a remote file."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.remove"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.remove"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "files.remote.share",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.share?channels=&token=&external_id=&file=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.share"
],
"query": [
{
"key": "channels",
"value": "",
"description": "Comma-separated list of channel IDs where the file will be shared."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `remote_files:share`"
},
{
"key": "external_id",
"value": "",
"description": "Creator defined GUID for the file."
},
{
"key": "file",
"value": "",
"description": "Specify a file by providing its ID."
}
]
},
"description": "Share a remote file into a channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.share?channels=&token=&external_id=&file=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.share"
],
"query": [
{
"key": "channels",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "external_id",
"value": ""
},
{
"key": "file",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.share?channels=&token=&external_id=&file=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.share"
],
"query": [
{
"key": "channels",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "external_id",
"value": ""
},
{
"key": "file",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "files.remote.update",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.update",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.update"
]
},
"description": "Updates an existing remote file."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.update",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.update"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.remote.update",
"host": [
"{{baseUrl}}"
],
"path": [
"files.remote.update"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {},
"_postman_isSubFolder": true
},
{
"name": "comments",
"item": [
{
"name": "files.comments.delete",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/files.comments.delete",
"host": [
"{{baseUrl}}"
],
"path": [
"files.comments.delete"
]
},
"description": "Deletes an existing comment on a file."
},
"response": [
{
"name": "Standard success response is very simple",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/files.comments.delete",
"host": [
"{{baseUrl}}"
],
"path": [
"files.comments.delete"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Standard failure response when used with an invalid token",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/files.comments.delete",
"host": [
"{{baseUrl}}"
],
"path": [
"files.comments.delete"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {},
"_postman_isSubFolder": true
},
{
"name": "files.delete",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/files.delete",
"host": [
"{{baseUrl}}"
],
"path": [
"files.delete"
]
},
"description": "Deletes a file."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/files.delete",
"host": [
"{{baseUrl}}"
],
"path": [
"files.delete"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/files.delete",
"host": [
"{{baseUrl}}"
],
"path": [
"files.delete"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "files.info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.info?count=&cursor=&token=&limit=&file=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.info"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more details."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:read`"
},
{
"key": "limit",
"value": "",
"description": "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."
},
{
"key": "file",
"value": "",
"description": "Specify a file by providing its ID."
},
{
"key": "page",
"value": ""
}
]
},
"description": "Gets information about a team file."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.info?count=&cursor=&token=&limit=&file=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.info"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "file",
"value": ""
},
{
"key": "page",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.info?count=&cursor=&token=&limit=&file=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.info"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "file",
"value": ""
},
{
"key": "page",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "files.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.list?count=&channel=&ts_to=&ts_from=&token=&user=&show_files_hidden_by_limit=&page=&types=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.list"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "channel",
"value": "",
"description": "Filter files appearing in a specific channel, indicated by its ID."
},
{
"key": "ts_to",
"value": "",
"description": "Filter files created before this timestamp (inclusive)."
},
{
"key": "ts_from",
"value": "",
"description": "Filter files created after this timestamp (inclusive)."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:read`"
},
{
"key": "user",
"value": "",
"description": "Filter files created by a single user."
},
{
"key": "show_files_hidden_by_limit",
"value": "",
"description": "Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit."
},
{
"key": "page",
"value": ""
},
{
"key": "types",
"value": "",
"description": "Filter files by type ([see below](#file_types)). You can pass multiple values in the types argument, like `types=spaces,snippets`.The default value is `all`, which does not filter the list."
}
]
},
"description": "Lists & filters team files."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.list?count=&channel=&ts_to=&ts_from=&token=&user=&show_files_hidden_by_limit=&page=&types=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.list"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "ts_to",
"value": ""
},
{
"key": "ts_from",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
},
{
"key": "show_files_hidden_by_limit",
"value": ""
},
{
"key": "page",
"value": ""
},
{
"key": "types",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.list?count=&channel=&ts_to=&ts_from=&token=&user=&show_files_hidden_by_limit=&page=&types=",
"host": [
"{{baseUrl}}"
],
"path": [
"files.list"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "ts_to",
"value": ""
},
{
"key": "ts_from",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
},
{
"key": "show_files_hidden_by_limit",
"value": ""
},
{
"key": "page",
"value": ""
},
{
"key": "types",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "files.revokePublicURL",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/files.revokePublicURL",
"host": [
"{{baseUrl}}"
],
"path": [
"files.revokePublicURL"
]
},
"description": "Revokes public/external sharing access for a file"
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/files.revokePublicURL",
"host": [
"{{baseUrl}}"
],
"path": [
"files.revokePublicURL"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/files.revokePublicURL",
"host": [
"{{baseUrl}}"
],
"path": [
"files.revokePublicURL"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "files.sharedPublicURL",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/files.sharedPublicURL",
"host": [
"{{baseUrl}}"
],
"path": [
"files.sharedPublicURL"
]
},
"description": "Enables a file for public/external sharing."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/files.sharedPublicURL",
"host": [
"{{baseUrl}}"
],
"path": [
"files.sharedPublicURL"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `files:write:user`"
}
],
"url": {
"raw": "{{baseUrl}}/files.sharedPublicURL",
"host": [
"{{baseUrl}}"
],
"path": [
"files.sharedPublicURL"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "files.upload",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.upload",
"host": [
"{{baseUrl}}"
],
"path": [
"files.upload"
]
},
"description": "Uploads or creates a file."
},
"response": [
{
"name": "Success response after uploading a file to a channel with an initial message",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.upload",
"host": [
"{{baseUrl}}"
],
"path": [
"files.upload"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/files.upload",
"host": [
"{{baseUrl}}"
],
"path": [
"files.upload"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "groups",
"item": [
{
"name": "groups.archive",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.archive",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.archive"
]
},
"description": "Archives a private channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.archive",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.archive"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.archive",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.archive"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.create",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.create",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.create"
]
},
"description": "Creates a private channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.create",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.create"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.create",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.create"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.createChild",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.createChild",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.createChild"
]
},
"description": "Clones and archives a private channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.createChild",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.createChild"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.createChild",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.createChild"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.history",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.history?count=&unreads=&inclusive=&token=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.history"
],
"query": [
{
"key": "count",
"value": "",
"description": "Number of messages to return, between 1 and 1000."
},
{
"key": "unreads",
"value": "",
"description": "Include `unread_count_display` in the output?"
},
{
"key": "inclusive",
"value": "",
"description": "Include messages with latest or oldest timestamp in results."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:history`"
},
{
"key": "oldest",
"value": "",
"description": "Start of time range of messages to include in results."
},
{
"key": "channel",
"value": "",
"description": "Private channel to fetch history for."
},
{
"key": "latest",
"value": "",
"description": "End of time range of messages to include in results."
}
]
},
"description": "Fetches history of messages and events from a private channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.history?count=&unreads=&inclusive=&token=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.history"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "unreads",
"value": ""
},
{
"key": "inclusive",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.history?count=&unreads=&inclusive=&token=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.history"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "unreads",
"value": ""
},
{
"key": "inclusive",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.info?token=&include_locale=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.info"
],
"query": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:read`"
},
{
"key": "include_locale",
"value": "",
"description": "Set this to `true` to receive the locale for this group. Defaults to `false`"
},
{
"key": "channel",
"value": "",
"description": "Private channel to get info on"
}
]
},
"description": "Gets information about a private channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.info?token=&include_locale=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "include_locale",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.info?token=&include_locale=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "include_locale",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.invite",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.invite",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.invite"
]
},
"description": "Invites a user to a private channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.invite",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.invite"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.invite",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.invite"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.kick",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.kick",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.kick"
]
},
"description": "Removes a user from a private channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.kick",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.kick"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.kick",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.kick"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.leave",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.leave",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.leave"
]
},
"description": "Leaves a private channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.leave",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.leave"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.leave",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.leave"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.list?exclude_members=&cursor=&token=&limit=&exclude_archived=",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.list"
],
"query": [
{
"key": "exclude_members",
"value": "",
"description": "Exclude the `members` from each `group`"
},
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more details."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:read`"
},
{
"key": "limit",
"value": "",
"description": "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."
},
{
"key": "exclude_archived",
"value": "",
"description": "Don't return archived private channels."
}
]
},
"description": "Lists private channels that the calling user has access to."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.list?exclude_members=&cursor=&token=&limit=&exclude_archived=",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.list"
],
"query": [
{
"key": "exclude_members",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "exclude_archived",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.list?exclude_members=&cursor=&token=&limit=&exclude_archived=",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.list"
],
"query": [
{
"key": "exclude_members",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "exclude_archived",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.mark",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.mark",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.mark"
]
},
"description": "Sets the read cursor in a private channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.mark",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.mark"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.mark",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.mark"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.open",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.open",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.open"
]
},
"description": "Opens a private channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.open",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.open"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.open",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.open"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.rename",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.rename",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.rename"
]
},
"description": "Renames a private channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.rename",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.rename"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.rename",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.rename"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.replies",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.replies?thread_ts=&token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.replies"
],
"query": [
{
"key": "thread_ts",
"value": "",
"description": "Unique identifier of a thread's parent message"
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:history`"
},
{
"key": "channel",
"value": "",
"description": "Private channel to fetch thread from"
}
]
},
"description": "Retrieve a thread of messages posted to a private channel"
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.replies?thread_ts=&token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.replies"
],
"query": [
{
"key": "thread_ts",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/groups.replies?thread_ts=&token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.replies"
],
"query": [
{
"key": "thread_ts",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.setPurpose",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.setPurpose",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.setPurpose"
]
},
"description": "Sets the purpose for a private channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.setPurpose",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.setPurpose"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.setPurpose",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.setPurpose"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.setTopic",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.setTopic",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.setTopic"
]
},
"description": "Sets the topic for a private channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.setTopic",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.setTopic"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.setTopic",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.setTopic"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "groups.unarchive",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.unarchive"
]
},
"description": "Unarchives a private channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.unarchive"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `groups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/groups.unarchive",
"host": [
"{{baseUrl}}"
],
"path": [
"groups.unarchive"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "im",
"item": [
{
"name": "im.close",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `im:write`"
}
],
"url": {
"raw": "{{baseUrl}}/im.close",
"host": [
"{{baseUrl}}"
],
"path": [
"im.close"
]
},
"description": "Close a direct message channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `im:write`"
}
],
"url": {
"raw": "{{baseUrl}}/im.close",
"host": [
"{{baseUrl}}"
],
"path": [
"im.close"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `im:write`"
}
],
"url": {
"raw": "{{baseUrl}}/im.close",
"host": [
"{{baseUrl}}"
],
"path": [
"im.close"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "im.history",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/im.history?count=&unreads=&inclusive=&token=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"im.history"
],
"query": [
{
"key": "count",
"value": "",
"description": "Number of messages to return, between 1 and 1000."
},
{
"key": "unreads",
"value": "",
"description": "Include `unread_count_display` in the output?"
},
{
"key": "inclusive",
"value": "",
"description": "Include messages with latest or oldest timestamp in results."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `im:history`"
},
{
"key": "oldest",
"value": "",
"description": "Start of time range of messages to include in results."
},
{
"key": "channel",
"value": "",
"description": "Direct message channel to fetch history for."
},
{
"key": "latest",
"value": "",
"description": "End of time range of messages to include in results."
}
]
},
"description": "Fetches history of messages and events from direct message channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/im.history?count=&unreads=&inclusive=&token=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"im.history"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "unreads",
"value": ""
},
{
"key": "inclusive",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/im.history?count=&unreads=&inclusive=&token=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"im.history"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "unreads",
"value": ""
},
{
"key": "inclusive",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "im.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/im.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"im.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more detail."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `im:read`"
},
{
"key": "limit",
"value": "",
"description": "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."
}
]
},
"description": "Lists direct message channels for the calling user."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/im.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"im.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/im.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"im.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "im.mark",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `im:write`"
}
],
"url": {
"raw": "{{baseUrl}}/im.mark",
"host": [
"{{baseUrl}}"
],
"path": [
"im.mark"
]
},
"description": "Sets the read cursor in a direct message channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `im:write`"
}
],
"url": {
"raw": "{{baseUrl}}/im.mark",
"host": [
"{{baseUrl}}"
],
"path": [
"im.mark"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `im:write`"
}
],
"url": {
"raw": "{{baseUrl}}/im.mark",
"host": [
"{{baseUrl}}"
],
"path": [
"im.mark"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "im.open",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `im:write`"
}
],
"url": {
"raw": "{{baseUrl}}/im.open",
"host": [
"{{baseUrl}}"
],
"path": [
"im.open"
]
},
"description": "Opens a direct message channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `im:write`"
}
],
"url": {
"raw": "{{baseUrl}}/im.open",
"host": [
"{{baseUrl}}"
],
"path": [
"im.open"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `im:write`"
}
],
"url": {
"raw": "{{baseUrl}}/im.open",
"host": [
"{{baseUrl}}"
],
"path": [
"im.open"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "im.replies",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/im.replies?thread_ts=&token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"im.replies"
],
"query": [
{
"key": "thread_ts",
"value": "",
"description": "Unique identifier of a thread's parent message"
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `im:history`"
},
{
"key": "channel",
"value": "",
"description": "Direct message channel to fetch thread from"
}
]
},
"description": "Retrieve a thread of messages posted to a direct message conversation"
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/im.replies?thread_ts=&token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"im.replies"
],
"query": [
{
"key": "thread_ts",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/im.replies?thread_ts=&token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"im.replies"
],
"query": [
{
"key": "thread_ts",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "migration",
"item": [
{
"name": "migration.exchange",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/migration.exchange?token=&to_old=&users=",
"host": [
"{{baseUrl}}"
],
"path": [
"migration.exchange"
],
"query": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `tokens.basic`"
},
{
"key": "to_old",
"value": "",
"description": "Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`."
},
{
"key": "users",
"value": "",
"description": "(Required) A comma-separated list of user ids, up to 400 per request"
}
]
},
"description": "For Enterprise Grid workspaces, map local user IDs to global user IDs"
},
"response": [
{
"name": "Typical error response when there are no mappings to provide",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/migration.exchange?token=&to_old=&users=",
"host": [
"{{baseUrl}}"
],
"path": [
"migration.exchange"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "to_old",
"value": ""
},
{
"key": "users",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response when mappings exist for the specified user IDs",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/migration.exchange?token=&to_old=&users=",
"host": [
"{{baseUrl}}"
],
"path": [
"migration.exchange"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "to_old",
"value": ""
},
{
"key": "users",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "mpim",
"item": [
{
"name": "mpim.close",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `mpim:write`"
}
],
"url": {
"raw": "{{baseUrl}}/mpim.close",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.close"
]
},
"description": "Closes a multiparty direct message channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `mpim:write`"
}
],
"url": {
"raw": "{{baseUrl}}/mpim.close",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.close"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `mpim:write`"
}
],
"url": {
"raw": "{{baseUrl}}/mpim.close",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.close"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "mpim.history",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/mpim.history?count=&unreads=&inclusive=&token=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.history"
],
"query": [
{
"key": "count",
"value": "",
"description": "Number of messages to return, between 1 and 1000."
},
{
"key": "unreads",
"value": "",
"description": "Include `unread_count_display` in the output?"
},
{
"key": "inclusive",
"value": "",
"description": "Include messages with latest or oldest timestamp in results."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `mpim:history`"
},
{
"key": "oldest",
"value": "",
"description": "Start of time range of messages to include in results."
},
{
"key": "channel",
"value": "",
"description": "Multiparty direct message to fetch history for."
},
{
"key": "latest",
"value": "",
"description": "End of time range of messages to include in results."
}
]
},
"description": "Fetches history of messages and events from a multiparty direct message."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/mpim.history?count=&unreads=&inclusive=&token=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.history"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "unreads",
"value": ""
},
{
"key": "inclusive",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/mpim.history?count=&unreads=&inclusive=&token=&oldest=&channel=&latest=",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.history"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "unreads",
"value": ""
},
{
"key": "inclusive",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "oldest",
"value": ""
},
{
"key": "channel",
"value": ""
},
{
"key": "latest",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "mpim.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/mpim.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more details."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `mpim:read`"
},
{
"key": "limit",
"value": "",
"description": "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."
}
]
},
"description": "Lists multiparty direct message channels for the calling user."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/mpim.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/mpim.list?cursor=&token=&limit=",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "mpim.mark",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `mpim:write`"
}
],
"url": {
"raw": "{{baseUrl}}/mpim.mark",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.mark"
]
},
"description": "Sets the read cursor in a multiparty direct message channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `mpim:write`"
}
],
"url": {
"raw": "{{baseUrl}}/mpim.mark",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.mark"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `mpim:write`"
}
],
"url": {
"raw": "{{baseUrl}}/mpim.mark",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.mark"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "mpim.open",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `mpim:write`"
}
],
"url": {
"raw": "{{baseUrl}}/mpim.open",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.open"
]
},
"description": "This method opens a multiparty direct message."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `mpim:write`"
}
],
"url": {
"raw": "{{baseUrl}}/mpim.open",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.open"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `mpim:write`"
}
],
"url": {
"raw": "{{baseUrl}}/mpim.open",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.open"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "mpim.replies",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/mpim.replies?thread_ts=&token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.replies"
],
"query": [
{
"key": "thread_ts",
"value": "",
"description": "Unique identifier of a thread's parent message."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `mpim:history`"
},
{
"key": "channel",
"value": "",
"description": "Multiparty direct message channel to fetch thread from."
}
]
},
"description": "Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/mpim.replies?thread_ts=&token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.replies"
],
"query": [
{
"key": "thread_ts",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/mpim.replies?thread_ts=&token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"mpim.replies"
],
"query": [
{
"key": "thread_ts",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "oauth",
"item": [
{
"name": "oauth.access",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/oauth.access?code=&token=&redirect_uri=&single_channel=&client_id=&client_secret=",
"host": [
"{{baseUrl}}"
],
"path": [
"oauth.access"
],
"query": [
{
"key": "code",
"value": "",
"description": "The `code` param returned via the OAuth callback."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `none`"
},
{
"key": "redirect_uri",
"value": "",
"description": "This must match the originally submitted URI (if one was sent)."
},
{
"key": "single_channel",
"value": "",
"description": "Request the user to add your app only to a single channel. Only valid with a [legacy workspace app](https://api.slack.com/legacy-workspace-apps)."
},
{
"key": "client_id",
"value": "",
"description": "Issued when you created your application."
},
{
"key": "client_secret",
"value": "",
"description": "Issued when you created your application."
}
]
},
"description": "Exchanges a temporary OAuth verifier code for an access token."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/oauth.access?code=&token=&redirect_uri=&single_channel=&client_id=&client_secret=",
"host": [
"{{baseUrl}}"
],
"path": [
"oauth.access"
],
"query": [
{
"key": "code",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "redirect_uri",
"value": ""
},
{
"key": "single_channel",
"value": ""
},
{
"key": "client_id",
"value": ""
},
{
"key": "client_secret",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Successful user token negotiation for a single scope",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/oauth.access?code=&token=&redirect_uri=&single_channel=&client_id=&client_secret=",
"host": [
"{{baseUrl}}"
],
"path": [
"oauth.access"
],
"query": [
{
"key": "code",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "redirect_uri",
"value": ""
},
{
"key": "single_channel",
"value": ""
},
{
"key": "client_id",
"value": ""
},
{
"key": "client_secret",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "oauth.token",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/oauth.token?client_secret=&code=&single_channel=&client_id=&redirect_uri=",
"host": [
"{{baseUrl}}"
],
"path": [
"oauth.token"
],
"query": [
{
"key": "client_secret",
"value": "",
"description": "Issued when you created your application."
},
{
"key": "code",
"value": "",
"description": "The `code` param returned via the OAuth callback."
},
{
"key": "single_channel",
"value": "",
"description": "Request the user to add your app only to a single channel."
},
{
"key": "client_id",
"value": "",
"description": "Issued when you created your application."
},
{
"key": "redirect_uri",
"value": "",
"description": "This must match the originally submitted URI (if one was sent)."
}
]
},
"description": "Exchanges a temporary OAuth verifier code for a workspace token."
},
"response": [
{
"name": "Success example using a workspace app produces a very different kind of response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/oauth.token?client_secret=&code=&single_channel=&client_id=&redirect_uri=",
"host": [
"{{baseUrl}}"
],
"path": [
"oauth.token"
],
"query": [
{
"key": "client_secret",
"value": ""
},
{
"key": "code",
"value": ""
},
{
"key": "single_channel",
"value": ""
},
{
"key": "client_id",
"value": ""
},
{
"key": "redirect_uri",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/oauth.token?client_secret=&code=&single_channel=&client_id=&redirect_uri=",
"host": [
"{{baseUrl}}"
],
"path": [
"oauth.token"
],
"query": [
{
"key": "client_secret",
"value": ""
},
{
"key": "code",
"value": ""
},
{
"key": "single_channel",
"value": ""
},
{
"key": "client_id",
"value": ""
},
{
"key": "redirect_uri",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "oauth.v2.access",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/oauth.v2.access?client_secret=&code=&client_id=&redirect_uri=",
"host": [
"{{baseUrl}}"
],
"path": [
"oauth.v2.access"
],
"query": [
{
"key": "client_secret",
"value": "",
"description": "Issued when you created your application."
},
{
"key": "code",
"value": "",
"description": "(Required) The `code` param returned via the OAuth callback."
},
{
"key": "client_id",
"value": "",
"description": "Issued when you created your application."
},
{
"key": "redirect_uri",
"value": "",
"description": "This must match the originally submitted URI (if one was sent)."
}
]
},
"description": "Exchanges a temporary OAuth verifier code for an access token."
},
"response": [
{
"name": "Successful token request with scopes for both a bot user and a user token",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/oauth.v2.access?client_secret=&code=&client_id=&redirect_uri=",
"host": [
"{{baseUrl}}"
],
"path": [
"oauth.v2.access"
],
"query": [
{
"key": "client_secret",
"value": ""
},
{
"key": "code",
"value": ""
},
{
"key": "client_id",
"value": ""
},
{
"key": "redirect_uri",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/oauth.v2.access?client_secret=&code=&client_id=&redirect_uri=",
"host": [
"{{baseUrl}}"
],
"path": [
"oauth.v2.access"
],
"query": [
{
"key": "client_secret",
"value": ""
},
{
"key": "code",
"value": ""
},
{
"key": "client_id",
"value": ""
},
{
"key": "redirect_uri",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "pins",
"item": [
{
"name": "pins.add",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `pins:write`"
}
],
"url": {
"raw": "{{baseUrl}}/pins.add",
"host": [
"{{baseUrl}}"
],
"path": [
"pins.add"
]
},
"description": "Pins an item to a channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `pins:write`"
}
],
"url": {
"raw": "{{baseUrl}}/pins.add",
"host": [
"{{baseUrl}}"
],
"path": [
"pins.add"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `pins:write`"
}
],
"url": {
"raw": "{{baseUrl}}/pins.add",
"host": [
"{{baseUrl}}"
],
"path": [
"pins.add"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "pins.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/pins.list?token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"pins.list"
],
"query": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `pins:read`"
},
{
"key": "channel",
"value": "",
"description": "Channel to get pinned items for."
}
]
},
"description": "Lists items pinned to a channel."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/pins.list?token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"pins.list"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/pins.list?token=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"pins.list"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "pins.remove",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `pins:write`"
}
],
"url": {
"raw": "{{baseUrl}}/pins.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"pins.remove"
]
},
"description": "Un-pins an item from a channel."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `pins:write`"
}
],
"url": {
"raw": "{{baseUrl}}/pins.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"pins.remove"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `pins:write`"
}
],
"url": {
"raw": "{{baseUrl}}/pins.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"pins.remove"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "reactions",
"item": [
{
"name": "reactions.add",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `reactions:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reactions.add",
"host": [
"{{baseUrl}}"
],
"path": [
"reactions.add"
]
},
"description": "Adds a reaction to an item."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `reactions:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reactions.add",
"host": [
"{{baseUrl}}"
],
"path": [
"reactions.add"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `reactions:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reactions.add",
"host": [
"{{baseUrl}}"
],
"path": [
"reactions.add"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "reactions.get",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reactions.get?full=&file_comment=&timestamp=&token=&file=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"reactions.get"
],
"query": [
{
"key": "full",
"value": "",
"description": "If true always return the complete reaction list."
},
{
"key": "file_comment",
"value": "",
"description": "File comment to get reactions for."
},
{
"key": "timestamp",
"value": "",
"description": "Timestamp of the message to get reactions for."
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `reactions:read`"
},
{
"key": "file",
"value": "",
"description": "File to get reactions for."
},
{
"key": "channel",
"value": "",
"description": "Channel where the message to get reactions for was posted."
}
]
},
"description": "Gets reactions for an item."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reactions.get?full=&file_comment=&timestamp=&token=&file=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"reactions.get"
],
"query": [
{
"key": "full",
"value": ""
},
{
"key": "file_comment",
"value": ""
},
{
"key": "timestamp",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "file",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reactions.get?full=&file_comment=&timestamp=&token=&file=&channel=",
"host": [
"{{baseUrl}}"
],
"path": [
"reactions.get"
],
"query": [
{
"key": "full",
"value": ""
},
{
"key": "file_comment",
"value": ""
},
{
"key": "timestamp",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "file",
"value": ""
},
{
"key": "channel",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "reactions.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reactions.list?count=&full=&cursor=&token=&limit=&user=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"reactions.list"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "full",
"value": "",
"description": "If true always return the complete reaction list."
},
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more details."
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `reactions:read`"
},
{
"key": "limit",
"value": "",
"description": "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."
},
{
"key": "user",
"value": "",
"description": "Show reactions made by this user. Defaults to the authed user."
},
{
"key": "page",
"value": ""
}
]
},
"description": "Lists reactions made by a user."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reactions.list?count=&full=&cursor=&token=&limit=&user=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"reactions.list"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "full",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "user",
"value": ""
},
{
"key": "page",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reactions.list?count=&full=&cursor=&token=&limit=&user=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"reactions.list"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "full",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "user",
"value": ""
},
{
"key": "page",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "reactions.remove",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `reactions:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reactions.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"reactions.remove"
]
},
"description": "Removes a reaction from an item."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `reactions:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reactions.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"reactions.remove"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `reactions:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reactions.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"reactions.remove"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "reminders",
"item": [
{
"name": "reminders.add",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `reminders:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reminders.add",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.add"
]
},
"description": "Creates a reminder."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `reminders:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reminders.add",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.add"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `reminders:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reminders.add",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.add"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "reminders.complete",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `reminders:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reminders.complete",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.complete"
]
},
"description": "Marks a reminder as complete."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `reminders:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reminders.complete",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.complete"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `reminders:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reminders.complete",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.complete"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "reminders.delete",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `reminders:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reminders.delete",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.delete"
]
},
"description": "Deletes a reminder."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `reminders:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reminders.delete",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.delete"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `reminders:write`"
}
],
"url": {
"raw": "{{baseUrl}}/reminders.delete",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.delete"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "reminders.info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reminders.info?token=&reminder=",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.info"
],
"query": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `reminders:read`"
},
{
"key": "reminder",
"value": "",
"description": "The ID of the reminder"
}
]
},
"description": "Gets information about a reminder."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reminders.info?token=&reminder=",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "reminder",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reminders.info?token=&reminder=",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "reminder",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "reminders.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reminders.list?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.list"
],
"query": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `reminders:read`"
}
]
},
"description": "Lists all reminders created by or for a given user."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reminders.list?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.list"
],
"query": [
{
"key": "token",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reminders.list?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"reminders.list"
],
"query": [
{
"key": "token",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "rtm",
"item": [
{
"name": "rtm.connect",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/rtm.connect?presence_sub=&token=&batch_presence_aware=",
"host": [
"{{baseUrl}}"
],
"path": [
"rtm.connect"
],
"query": [
{
"key": "presence_sub",
"value": "",
"description": "Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions)."
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `rtm:stream`"
},
{
"key": "batch_presence_aware",
"value": "",
"description": "Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching)."
}
]
},
"description": "Starts a Real Time Messaging session."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/rtm.connect?presence_sub=&token=&batch_presence_aware=",
"host": [
"{{baseUrl}}"
],
"path": [
"rtm.connect"
],
"query": [
{
"key": "presence_sub",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "batch_presence_aware",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/rtm.connect?presence_sub=&token=&batch_presence_aware=",
"host": [
"{{baseUrl}}"
],
"path": [
"rtm.connect"
],
"query": [
{
"key": "presence_sub",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "batch_presence_aware",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "search",
"item": [
{
"name": "search.messages",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/search.messages?sort_dir=&query=&sort=&count=&token=&highlight=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"search.messages"
],
"query": [
{
"key": "sort_dir",
"value": "",
"description": "Change sort direction to ascending (`asc`) or descending (`desc`)."
},
{
"key": "query",
"value": "",
"description": "(Required) Search query."
},
{
"key": "sort",
"value": "",
"description": "Return matches sorted by either `score` or `timestamp`."
},
{
"key": "count",
"value": "",
"description": "Pass the number of results you want per \"page\". Maximum of `100`."
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `search:read`"
},
{
"key": "highlight",
"value": "",
"description": "Pass a value of `true` to enable query highlight markers (see below)."
},
{
"key": "page",
"value": ""
}
]
},
"description": "Searches for messages matching a query."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/search.messages?sort_dir=&query=&sort=&count=&token=&highlight=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"search.messages"
],
"query": [
{
"key": "sort_dir",
"value": ""
},
{
"key": "query",
"value": ""
},
{
"key": "sort",
"value": ""
},
{
"key": "count",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "highlight",
"value": ""
},
{
"key": "page",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/search.messages?sort_dir=&query=&sort=&count=&token=&highlight=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"search.messages"
],
"query": [
{
"key": "sort_dir",
"value": ""
},
{
"key": "query",
"value": ""
},
{
"key": "sort",
"value": ""
},
{
"key": "count",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "highlight",
"value": ""
},
{
"key": "page",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "stars",
"item": [
{
"name": "stars.add",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `stars:write`"
}
],
"url": {
"raw": "{{baseUrl}}/stars.add",
"host": [
"{{baseUrl}}"
],
"path": [
"stars.add"
]
},
"description": "Adds a star to an item."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `stars:write`"
}
],
"url": {
"raw": "{{baseUrl}}/stars.add",
"host": [
"{{baseUrl}}"
],
"path": [
"stars.add"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `stars:write`"
}
],
"url": {
"raw": "{{baseUrl}}/stars.add",
"host": [
"{{baseUrl}}"
],
"path": [
"stars.add"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "stars.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/stars.list?count=&cursor=&token=&limit=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"stars.list"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more details."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `stars:read`"
},
{
"key": "limit",
"value": "",
"description": "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."
},
{
"key": "page",
"value": ""
}
]
},
"description": "Lists stars for a user."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/stars.list?count=&cursor=&token=&limit=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"stars.list"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "page",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/stars.list?count=&cursor=&token=&limit=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"stars.list"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "page",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "stars.remove",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `stars:write`"
}
],
"url": {
"raw": "{{baseUrl}}/stars.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"stars.remove"
]
},
"description": "Removes a star from an item."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `stars:write`"
}
],
"url": {
"raw": "{{baseUrl}}/stars.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"stars.remove"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `stars:write`"
}
],
"url": {
"raw": "{{baseUrl}}/stars.remove",
"host": [
"{{baseUrl}}"
],
"path": [
"stars.remove"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "team",
"item": [
{
"name": "team.accessLogs",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.accessLogs?count=&token=&page=&before=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.accessLogs"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin`"
},
{
"key": "page",
"value": ""
},
{
"key": "before",
"value": "",
"description": "End of time range of logs to include in results (inclusive)."
}
]
},
"description": "Gets the access logs for the current team."
},
"response": [
{
"name": "A workspace must be on a paid plan to use this method, otherwise the `paid_only` error is thrown:",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.accessLogs?count=&token=&page=&before=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.accessLogs"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "page",
"value": ""
},
{
"key": "before",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "This response demonstrates pagination and two access log entries.",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.accessLogs?count=&token=&page=&before=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.accessLogs"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "page",
"value": ""
},
{
"key": "before",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "team.billableInfo",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.billableInfo?token=&user=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.billableInfo"
],
"query": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin`"
},
{
"key": "user",
"value": "",
"description": "A user to retrieve the billable information for. Defaults to all users."
}
]
},
"description": "Gets billable users information for the current team."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.billableInfo?token=&user=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.billableInfo"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.billableInfo?token=&user=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.billableInfo"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "team.info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.info?token=&team=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.info"
],
"query": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `team:read`"
},
{
"key": "team",
"value": "",
"description": "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"
}
]
},
"description": "Gets information about the current team."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.info?token=&team=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "team",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.info?token=&team=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "team",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "team.integrationLogs",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.integrationLogs?count=&change_type=&app_id=&token=&user=&service_id=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.integrationLogs"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "change_type",
"value": "",
"description": "Filter logs with this change type. Defaults to all logs."
},
{
"key": "app_id",
"value": "",
"description": "Filter logs to this Slack app. Defaults to all logs."
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `admin`"
},
{
"key": "user",
"value": "",
"description": "Filter logs generated by this user’s actions. Defaults to all logs."
},
{
"key": "service_id",
"value": "",
"description": "Filter logs to this service. Defaults to all logs."
},
{
"key": "page",
"value": ""
}
]
},
"description": "Gets the integration logs for the current team."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.integrationLogs?count=&change_type=&app_id=&token=&user=&service_id=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.integrationLogs"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "change_type",
"value": ""
},
{
"key": "app_id",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
},
{
"key": "service_id",
"value": ""
},
{
"key": "page",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.integrationLogs?count=&change_type=&app_id=&token=&user=&service_id=&page=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.integrationLogs"
],
"query": [
{
"key": "count",
"value": ""
},
{
"key": "change_type",
"value": ""
},
{
"key": "app_id",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
},
{
"key": "service_id",
"value": ""
},
{
"key": "page",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "team.profile.get",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.profile.get?token=&visibility=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.profile.get"
],
"query": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `users.profile:read`"
},
{
"key": "visibility",
"value": "",
"description": "Filter by visibility."
}
]
},
"description": "Retrieve a team's profile."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.profile.get?token=&visibility=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.profile.get"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "visibility",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/team.profile.get?token=&visibility=",
"host": [
"{{baseUrl}}"
],
"path": [
"team.profile.get"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "visibility",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "usergroups",
"item": [
{
"name": "usergroups.create",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.create",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.create"
]
},
"description": "Create a User Group"
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.create",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.create"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.create",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.create"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "usergroups.disable",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.disable",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.disable"
]
},
"description": "Disable an existing User Group"
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.disable",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.disable"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.disable",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.disable"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "usergroups.enable",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.enable",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.enable"
]
},
"description": "Enable a User Group"
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.enable",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.enable"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.enable",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.enable"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "usergroups.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/usergroups.list?include_users=&token=&include_count=&include_disabled=",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.list"
],
"query": [
{
"key": "include_users",
"value": "",
"description": "Include the list of users for each User Group."
},
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:read`"
},
{
"key": "include_count",
"value": "",
"description": "Include the number of users in each User Group."
},
{
"key": "include_disabled",
"value": "",
"description": "Include disabled User Groups."
}
]
},
"description": "List all User Groups for a team"
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/usergroups.list?include_users=&token=&include_count=&include_disabled=",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.list"
],
"query": [
{
"key": "include_users",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "include_count",
"value": ""
},
{
"key": "include_disabled",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/usergroups.list?include_users=&token=&include_count=&include_disabled=",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.list"
],
"query": [
{
"key": "include_users",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "include_count",
"value": ""
},
{
"key": "include_disabled",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "usergroups.update",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.update",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.update"
]
},
"description": "Update an existing User Group"
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.update",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.update"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.update",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.update"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "usergroups.users.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/usergroups.users.list?token=&include_disabled=&usergroup=",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.users.list"
],
"query": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:read`"
},
{
"key": "include_disabled",
"value": "",
"description": "Allow results that involve disabled User Groups."
},
{
"key": "usergroup",
"value": "",
"description": "(Required) The encoded ID of the User Group to update."
}
]
},
"description": "List all users in a User Group"
},
"response": [
{
"name": "Standard failure response when used with an invalid token",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/usergroups.users.list?token=&include_disabled=&usergroup=",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.users.list"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "include_disabled",
"value": ""
},
{
"key": "usergroup",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Standard success response when used with a user token",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/usergroups.users.list?token=&include_disabled=&usergroup=",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.users.list"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "include_disabled",
"value": ""
},
{
"key": "usergroup",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "usergroups.users.update",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.users.update",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.users.update"
]
},
"description": "Update the list of users for a User Group"
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.users.update",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.users.update"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `usergroups:write`"
}
],
"url": {
"raw": "{{baseUrl}}/usergroups.users.update",
"host": [
"{{baseUrl}}"
],
"path": [
"usergroups.users.update"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "users",
"item": [
{
"name": "users.conversations",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.conversations?cursor=&token=&limit=&user=&exclude_archived=&types=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.conversations"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more detail."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `conversations:read`"
},
{
"key": "limit",
"value": "",
"description": "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."
},
{
"key": "user",
"value": "",
"description": "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership."
},
{
"key": "exclude_archived",
"value": "",
"description": "Set to `true` to exclude archived channels from the list"
},
{
"key": "types",
"value": "",
"description": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`"
}
]
},
"description": "List conversations the calling user may access."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.conversations?cursor=&token=&limit=&user=&exclude_archived=&types=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.conversations"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "user",
"value": ""
},
{
"key": "exclude_archived",
"value": ""
},
{
"key": "types",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response with only public channels. Note how `num_members` and `is_member` are not returned like typical `conversations` objects.",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.conversations?cursor=&token=&limit=&user=&exclude_archived=&types=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.conversations"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "user",
"value": ""
},
{
"key": "exclude_archived",
"value": ""
},
{
"key": "types",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "users.deletePhoto",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.deletePhoto",
"host": [
"{{baseUrl}}"
],
"path": [
"users.deletePhoto"
]
},
"description": "Delete the user profile photo"
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.deletePhoto",
"host": [
"{{baseUrl}}"
],
"path": [
"users.deletePhoto"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.deletePhoto",
"host": [
"{{baseUrl}}"
],
"path": [
"users.deletePhoto"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "users.getPresence",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.getPresence?token=&user=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.getPresence"
],
"query": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `users:read`"
},
{
"key": "user",
"value": "",
"description": "User to get presence info on. Defaults to the authed user."
}
]
},
"description": "Gets user presence information."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.getPresence?token=&user=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.getPresence"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "When requesting information for a different user, this method just returns the current presence (either `active` or `away`).",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.getPresence?token=&user=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.getPresence"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "users.identity",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.identity?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.identity"
],
"query": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `identity.basic`"
}
]
},
"description": "Get a user's identity."
},
"response": [
{
"name": "You will receive at a minimum the following information:",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.identity?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.identity"
],
"query": [
{
"key": "token",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.identity?token=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.identity"
],
"query": [
{
"key": "token",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "users.info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.info?token=&user=&include_locale=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.info"
],
"query": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `users:read`"
},
{
"key": "user",
"value": "",
"description": "User to get info on"
},
{
"key": "include_locale",
"value": "",
"description": "Set this to `true` to receive the locale for this user. Defaults to `false`"
}
]
},
"description": "Gets information about a user."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.info?token=&user=&include_locale=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
},
{
"key": "include_locale",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.info?token=&user=&include_locale=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.info"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "user",
"value": ""
},
{
"key": "include_locale",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "users.list",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.list?cursor=&token=&limit=&include_locale=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.list"
],
"query": [
{
"key": "cursor",
"value": "",
"description": "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](/docs/pagination) for more detail."
},
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `users:read`"
},
{
"key": "limit",
"value": "",
"description": "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."
},
{
"key": "include_locale",
"value": "",
"description": "Set this to `true` to receive the locale for users. Defaults to `false`"
}
]
},
"description": "Lists all users in a Slack team."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.list?cursor=&token=&limit=&include_locale=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "include_locale",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.list?cursor=&token=&limit=&include_locale=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.list"
],
"query": [
{
"key": "cursor",
"value": ""
},
{
"key": "token",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "include_locale",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "users.lookupByEmail",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.lookupByEmail?token=&email=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.lookupByEmail"
],
"query": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `users:read.email`"
},
{
"key": "email",
"value": "",
"description": "An email address belonging to a user in the workspace"
}
]
},
"description": "Find a user with an email address."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.lookupByEmail?token=&email=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.lookupByEmail"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "email",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.lookupByEmail?token=&email=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.lookupByEmail"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "email",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "users.profile.get",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.profile.get?token=&include_labels=&user=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.profile.get"
],
"query": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `users.profile:read`"
},
{
"key": "include_labels",
"value": "",
"description": "Include labels for each ID in custom profile fields"
},
{
"key": "user",
"value": "",
"description": "User to retrieve profile info for"
}
]
},
"description": "Retrieves a user's profile information."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.profile.get?token=&include_labels=&user=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.profile.get"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "include_labels",
"value": ""
},
{
"key": "user",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.profile.get?token=&include_labels=&user=",
"host": [
"{{baseUrl}}"
],
"path": [
"users.profile.get"
],
"query": [
{
"key": "token",
"value": ""
},
{
"key": "include_labels",
"value": ""
},
{
"key": "user",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "users.profile.set",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `users.profile:write`"
}
],
"url": {
"raw": "{{baseUrl}}/users.profile.set",
"host": [
"{{baseUrl}}"
],
"path": [
"users.profile.set"
]
},
"description": "Set the profile information for a user."
},
"response": [
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `users.profile:write`"
}
],
"url": {
"raw": "{{baseUrl}}/users.profile.set",
"host": [
"{{baseUrl}}"
],
"path": [
"users.profile.set"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "Authentication token. Requires scope: `users.profile:write`"
}
],
"url": {
"raw": "{{baseUrl}}/users.profile.set",
"host": [
"{{baseUrl}}"
],
"path": [
"users.profile.set"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "users.setActive",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/users.setActive",
"host": [
"{{baseUrl}}"
],
"path": [
"users.setActive"
]
},
"description": "Marked a user as active. Deprecated and non-functional."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/users.setActive",
"host": [
"{{baseUrl}}"
],
"path": [
"users.setActive"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/users.setActive",
"host": [
"{{baseUrl}}"
],
"path": [
"users.setActive"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "users.setPhoto",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.setPhoto",
"host": [
"{{baseUrl}}"
],
"path": [
"users.setPhoto"
]
},
"description": "Set the user profile photo"
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.setPhoto",
"host": [
"{{baseUrl}}"
],
"path": [
"users.setPhoto"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/users.setPhoto",
"host": [
"{{baseUrl}}"
],
"path": [
"users.setPhoto"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "users.setPresence",
"request": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/users.setPresence",
"host": [
"{{baseUrl}}"
],
"path": [
"users.setPresence"
]
},
"description": "Manually sets user presence."
},
"response": [
{
"name": "Typical error response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/users.setPresence",
"host": [
"{{baseUrl}}"
],
"path": [
"users.setPresence"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `users:write`"
}
],
"url": {
"raw": "{{baseUrl}}/users.setPresence",
"host": [
"{{baseUrl}}"
],
"path": [
"users.setPresence"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
},
{
"name": "views",
"item": [
{
"name": "views.open",
"request": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/views.open?trigger_id=&view=",
"host": [
"{{baseUrl}}"
],
"path": [
"views.open"
],
"query": [
{
"key": "trigger_id",
"value": "",
"description": "(Required) Exchange a trigger to post to the user."
},
{
"key": "view",
"value": "",
"description": "(Required) A [view payload](/reference/surfaces/views). This must be a JSON-encoded string."
}
]
},
"description": "Open a view for a user."
},
"response": [
{
"name": "Typical error response, before getting to any possible validation errors.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/views.open?trigger_id=&view=",
"host": [
"{{baseUrl}}"
],
"path": [
"views.open"
],
"query": [
{
"key": "trigger_id",
"value": ""
},
{
"key": "view",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response includes the opened view payload.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/views.open?trigger_id=&view=",
"host": [
"{{baseUrl}}"
],
"path": [
"views.open"
],
"query": [
{
"key": "trigger_id",
"value": ""
},
{
"key": "view",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "views.publish",
"request": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/views.publish?hash=&user_id=&view=",
"host": [
"{{baseUrl}}"
],
"path": [
"views.publish"
],
"query": [
{
"key": "hash",
"value": "",
"description": "A string that represents view state to protect against possible race conditions."
},
{
"key": "user_id",
"value": "",
"description": "(Required) `id` of the user you want publish a view to."
},
{
"key": "view",
"value": "",
"description": "(Required) A [view payload](/reference/surfaces/views). This must be a JSON-encoded string."
}
]
},
"description": "Publish a static view for a User."
},
"response": [
{
"name": "Typical success response includes the published view payload.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/views.publish?hash=&user_id=&view=",
"host": [
"{{baseUrl}}"
],
"path": [
"views.publish"
],
"query": [
{
"key": "hash",
"value": ""
},
{
"key": "user_id",
"value": ""
},
{
"key": "view",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response, before getting to any possible validation errors.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/views.publish?hash=&user_id=&view=",
"host": [
"{{baseUrl}}"
],
"path": [
"views.publish"
],
"query": [
{
"key": "hash",
"value": ""
},
{
"key": "user_id",
"value": ""
},
{
"key": "view",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "views.push",
"request": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/views.push?trigger_id=&view=",
"host": [
"{{baseUrl}}"
],
"path": [
"views.push"
],
"query": [
{
"key": "trigger_id",
"value": "",
"description": "(Required) Exchange a trigger to post to the user."
},
{
"key": "view",
"value": "",
"description": "(Required) A [view payload](/reference/surfaces/views). This must be a JSON-encoded string."
}
]
},
"description": "Push a view onto the stack of a root view."
},
"response": [
{
"name": "Typical success response includes the pushed view payload.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/views.push?trigger_id=&view=",
"host": [
"{{baseUrl}}"
],
"path": [
"views.push"
],
"query": [
{
"key": "trigger_id",
"value": ""
},
{
"key": "view",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/views.push?trigger_id=&view=",
"host": [
"{{baseUrl}}"
],
"path": [
"views.push"
],
"query": [
{
"key": "trigger_id",
"value": ""
},
{
"key": "view",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
},
{
"name": "views.update",
"request": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/views.update?hash=&view_id=&external_id=&view=",
"host": [
"{{baseUrl}}"
],
"path": [
"views.update"
],
"query": [
{
"key": "hash",
"value": "",
"description": "A string that represents view state to protect against possible race conditions."
},
{
"key": "view_id",
"value": "",
"description": "A unique identifier of the view to be updated. Either `view_id` or `external_id` is required."
},
{
"key": "external_id",
"value": "",
"description": "A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either `view_id` or `external_id` is required."
},
{
"key": "view",
"value": "",
"description": "A [view payload](/reference/surfaces/views) This must be a JSON-encoded string."
}
]
},
"description": "Update an existing view."
},
"response": [
{
"name": "Typical error response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/views.update?hash=&view_id=&external_id=&view=",
"host": [
"{{baseUrl}}"
],
"path": [
"views.update"
],
"query": [
{
"key": "hash",
"value": ""
},
{
"key": "view_id",
"value": ""
},
{
"key": "external_id",
"value": ""
},
{
"key": "view",
"value": ""
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
},
{
"name": "Typical success response includes the updated view payload.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "token",
"value": "",
"description": "(Required) Authentication token. Requires scope: `none`"
}
],
"url": {
"raw": "{{baseUrl}}/views.update?hash=&view_id=&external_id=&view=",
"host": [
"{{baseUrl}}"
],
"path": [
"views.update"
],
"query": [
{
"key": "hash",
"value": ""
},
{
"key": "view_id",
"value": ""
},
{
"key": "external_id",
"value": ""
},
{
"key": "view",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [],
"body": ""
}
]
}
],
"protocolProfileBehavior": {}
}
],
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{botToken}}",
"type": "string"
}
]
},
"event": [
{
"listen": "prerequest",
"script": {
"id": "0821aad8-5069-4275-a5dd-52633b9322bd",
"type": "text/javascript",
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"id": "b2b592da-8104-42fe-bb91-a201ad792df7",
"type": "text/javascript",
"exec": [
""
]
}
}
],
"variable": [
{
"id": "056fecb4-5e07-4991-bbbf-7e90ada8b149",
"key": "baseUrl",
"value": "https://slack.com/api",
"type": "string"
},
{
"id": "04755e30-4d7d-4ca0-a901-f08ada6c5010",
"key": "botToken",
"value": "",
"type": "string"
}
],
"protocolProfileBehavior": {}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment