Actions173
- Bots Actions
- Channels Actions
- Get A List Of All Channels
- Create A Channel
- Create A Direct Message Channel
- Create A Group Message Channel
- Search All Private And Open Type Channels
- Search Group Channels
- Get A List Of Channels By Ids
- Get A Channel
- Update A Channel
- Delete A Channel
- Patch A Channel
- Update Channel's Privacy
- Restore A Channel
- Move A Channel
- Get Channel Statistics
- Get A Channel's Pinned Posts
- Get Public Channels
- Get Private Channels
- Get Deleted Channels
- Autocomplete Channels
- Autocomplete Channels For Search
- Search Channels
- Search Archived Channels
- Get A Channel By Name
- Get A Channel By Name And Team Name
- Get Channel Members
- Add User(s) To Channel
- Get Channel Members By Ids
- Get Channel Member
- Remove User From Channel
- Update Channel Roles
- Update The Scheme Derived Roles Of A Channel Member.
- Update Channel Notifications
- View Channel
- Get Channel Memberships And Roles For A User
- Get Channels For User
- Get All Channels
- Get Unread Messages
- Set A Channel's Scheme
- Get Information About Channel's Moderation.
- Update A Channel's Moderation Settings.
- Get User's Sidebar Categories
- Create User's Sidebar Category
- Update User's Sidebar Categories
- Get User's Sidebar Category Order
- Update User's Sidebar Category Order
- Get Sidebar Category
- Update Sidebar Category
- Delete Sidebar Category
- Commands Actions
- Emoji Actions
- Files Actions
- Groups Actions
- Insights Actions
- Get A List Of The Top Reactions For A Team.
- Get A List Of The Top Reactions For A User.
- Get A List Of The Top Channels For A Team.
- Get A List Of The Top Channels For A User.
- Get A List Of New Team Members.
- Get A List Of The Top Threads For A Team.
- Get A List Of The Top Threads For A User.
- Get A List Of The Top Dms For A User.
- Posts Actions
- Create A Post
- Create A Ephemeral Post
- Get A Post
- Delete A Post
- Mark As Unread From A Post.
- Patch A Post
- Get A Thread
- Get A List Of Flagged Posts
- Get File Info For Post
- Get Posts For A Channel
- Get Posts Around Oldest Unread
- Search For Team Posts
- Pin A Post To The Channel
- Unpin A Post To The Channel
- Perform A Post Action
- Get Posts By A List Of Ids
- Set A Post Reminder
- Preferences Actions
- Reactions Actions
- Roles Actions
- Status Actions
- System Actions
- Teams Actions
- Threads Actions
- Users Actions
- Get Users
- Get Users By Ids
- Get Users By Group Channels Ids
- Get Users By Usernames
- Search Users
- Autocomplete Users
- Get A User
- Patch A User
- Update A User's Roles
- Get User's Profile Image
- Return User's Default (generated) Profile Image
- Get A User By Username
- Get A User By Email
- Publish A User Typing Websocket Event.
- Get All Channel Members For A User
- Webhooks Actions
Roles → Get A Role By Name
AI-generatedSummary
Retrieve a role by name from an Infomaniak kChat team.
Inputs
- authentication — Authentication method to use for the API request. Defaults to OAuth2 if not specified. Select OAuth2 or API Key.
- teamName (required) — Your kChat team name (the subdomain in https://
.kchat.infomaniak.com). - path_role_name (required) — Role Name to look up.
- returnFullResponse — If true, returns the full API response object; otherwise returns the role data.
Output shape
object
Returns role details when returnFullResponse is false; returns the complete Infomaniak API response when true.