Skip to main content

TwistScope

type TwistScope = 
| "user:read"
| "user:write"
| "workspaces:read"
| "workspaces:write"
| "channels:read"
| "channels:write"
| "channels:remove"
| "threads:read"
| "threads:write"
| "threads:remove"
| "comments:read"
| "comments:write"
| "comments:remove"
| "groups:read"
| "groups:write"
| "groups:remove"
| "messages:read"
| "messages:write"
| "messages:remove"
| "reactions:read"
| "reactions:write"
| "reactions:remove"
| "search:read"
| "attachments:read"
| "attachments:write"
| "notifications:read"
| "notifications:write";

OAuth scopes for the Twist API.

Remarks

Request only the scopes your application needs:

User Scopes:

  • user:read - Access user's personal settings
  • user:write - Access and update user's personal settings

Workspace Scopes:

  • workspaces:read - Access teams the user is part of
  • workspaces:write - Access and update teams the user is part of

Channel Scopes:

  • channels:read - Access channels
  • channels:write - Access and update channels
  • channels:remove - Access, update, and delete channels

Thread Scopes:

  • threads:read - Access threads
  • threads:write - Access and update threads
  • threads:remove - Access, update, and delete threads

Comment Scopes:

  • comments:read - Access comments
  • comments:write - Access and update comments
  • comments:remove - Access, update, and delete comments

Group Scopes:

  • groups:read - Access groups
  • groups:write - Access and update groups
  • groups:remove - Access, update, and delete groups

Message Scopes:

  • messages:read - Access messages
  • messages:write - Access and update messages
  • messages:remove - Access, update, and delete messages

Reaction Scopes:

  • reactions:read - Access reactions
  • reactions:write - Access and update reactions
  • reactions:remove - Access, update, and delete reactions

Search Scopes:

  • search:read - Search

Attachment Scopes:

  • attachments:read - Access attachments
  • attachments:write - Access and update attachments

Notification Scopes:

  • notifications:read - Read user's notifications settings
  • notifications:write - Read and update user's notifications settings