Teamly API
  1. Announcements
Teamly API
  • Introduction
  • Getting Started
    • Quick Start
    • API Versions
  • Permissions
    • Channel Permission Values
    • Team Global Permissions
  • Core Resources
    • Channels
      • Update Channel
        • Update Team Channel
        • Update Channel Role Permissions
      • Get Team Channels
      • Create Team Channel
      • Delete Team Channel
      • Duplicate a Channel on Team
      • Update Channel Priorities of Team
      • Get Channel By Id
    • Messages
      • Create Channel Message
      • Delete a Channel Message
      • Get Channel Messages
      • Update a Channel Message
      • React to Message
      • Delete Reaction from Message
      • Get a Channel Message by Id
    • Teams
      • Members
        • Add Role to Member
        • Remove Role from Member
        • Kick Member from Team
        • Get Member
      • Bans
        • Get Banned Users
        • Unban User
        • Ban User
      • Get a Team
      • Update a Team
    • Roles
      • Create a Role for Team
      • Get Team Roles
      • Delete a Role
      • Clone Role
      • Update Role Priorities of Team
      • Update a Team Role
    • Users
      • Get User By Id
      • Get Logged In User
    • Todos
      • Get Todo Items
      • Create Todo Item
      • Delete Todo Item
      • Clone Todo Item
      • Update Todo Item
    • Direct Messages
      • Create a Direct Message
    • Applications
      • Get Application Submissions
      • Update a Application Status
      • Update Team's Application Status
      • Update Team's Application Questions
      • Get Application By Id
    • Reactions
      • Get Team's Custom Reactions
      • Create New Custom Reaction for Team
      • Update a Custom Reaction
      • Delete a Custom Reaction
    • Attachments
      • Upload Attachment
    • Voice
      • Get Credentials for Join Voice Channel
      • Update Your Voice Metadata
      • Leave from Voice Channel
    • Webhooks
      • Create Message With Webhook
      • Webhook for GitHub
    • Blog
      • Get Blog Posts
      • Create a Blog Post
      • Delete a Blog Post
    • Category
      • Create a Category
      • Update a Category
      • Update Category Role Permissions
      • Delete a Category
      • Add a Channel To Category
      • Delete a channel from category
      • Set channel priority of category
      • Set a team's category priority
    • Announcements
      • Get Announcements
        GET
      • Create Announcement
        POST
      • Delete Announcement
        DELETE
  • Schemas
    • Message
    • Message Embed
    • Channel
    • Direct Message
    • To-do Item
    • Application
    • Emoji
    • Team
    • User
    • Role
    • Webhook
    • Blog
    • Category
    • Announcement
  • Websockets
    • Example Bot
    • WebSocket event envelope
      • WebSocket event envelope
      • Keepalive
      • Welcome Message
      • Gateway Opcodes
      • Gateway Close Event Codes
    • Websocket events
      • CHANNEL_CREATED
      • CHANNEL_DELETED
      • CHANNEL_UPDATED
      • MESSAGE_SEND
      • MESSAGE_UPDATED
      • MESSAGE_DELETED
      • MESSAGE_REACTION_ADDED
      • MESSAGE_REACTION_REMOVED
      • PRESENCE_UPDATE
      • TEAM_ROLE_CREATED
      • TEAM_ROLE_DELETED
      • TEAM_ROLES_UPDATED
      • TEAM_UPDATED
      • TODO_ITEM_CREATED
      • TODO_ITEM_DELETED
      • TODO_ITEM_UPDATED
      • USER_JOINED_TEAM
      • USER_LEFT_TEAM
      • USER_JOINED_VOICE_CHANNEL
      • USER_LEFT_VOICE_CHANNEL
      • USER_PROFILE_UPDATED
      • USER_ROLE_ADDED
      • USER_ROLE_REMOVED
      • USER_UPDATED_VOICE_METADATA
      • BLOG_CREATED
      • BLOG_DELETED
      • CATEGORIES_PRIORITY_UPDATED
      • CATEGORY_UPDATED
      • CATEGORY_DELETED
      • CATEGORY_CREATED
      • CHANNELS_PRIORITY_UPDATED
      • ANNOUNCEMENT_CREATED
      • ANNOUNCEMENT_DELETED
    • Connecting via WebSocket
  1. Announcements

Get Announcements

GET
https://api.teamly.one/api/v1/channels/{channelId}/announcements

Request

Path Params
channelId
string 
required
Header Params
Authorization
string 
required
Default:
Bot {token}
Content-Type
string 
required
Default:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.teamly.one/api/v1/channels//announcements' \
--header 'Authorization;'

Responses

🟢200Success
application/json
Body
array of:
id
string 
required
Unique message ID
channelId
string 
required
ID of the channel this message belongs to
title
string 
required
Title of the Announcement
content
string 
required
Main content of the Announcement
createdBy
object (User) 
required
User ID of the creator
id
string 
required
Unique identifier for the user
username
string 
required
Username of the user
>= 1 characters<= 20 characters
subdomain
string 
required
Subdomain associated with the user
profilePicture
string <uri>
optional
URL to the user's profile picture
Default:
null
banner
string <uri>
optional
URL to the user's banner image
Default:
null
bot
boolean 
required
Indicates whether the user is a bot
Default:
false
presence
number 
required
Presence status of the user (e.g., online, offline, etc.)
>= 0<= 3
Default:
0
flags
string 
required
badges
array [object {3}] 
required
List of badges awarded to the user
userStatus
object 
optional
Status set by the user
userRPC
object 
optional
Rich presence details of the user
connections
array [object] 
required
List of external connections the user has
createdAt
string <date-time>
required
Timestamp of when the user was created
Default:
CURRENT_TIMESTAMP
lastOnline
string <date-time> | null 
deprecated
Timestamp of when the user was last online
Default:
CURRENT_TIMESTAMP
system
boolean 
required
Indicates whether the user is a system account
Default:
false
attachments
array [object {1}] 
optional
Attachments for the Announcement (may be empty)
<= 5 items
url
string 
required
emojis
array [object {1}] 
optional
emojiId
string 
optional
The emoji used in the message
mentions
object 
optional
Information about users mentioned in the Announcement
users
array[string]
optional
List of user IDs mentioned in the Announcement
reactions
array [object {3}] 
optional
emojiId
string 
optional
The emoji used for the reaction
count
number 
optional
Number of users who reacted with this emoji
users
array [object {2}] 
optional
createdAt
string <date-time>
required
Timestamp when the Announcement was created
editedAt
string <date-time> | null 
optional
Timestamp of last edit, if any
Example
[
    {
        "id": "string",
        "channelId": "string",
        "title": "string",
        "content": "string",
        "createdBy": {
            "id": "string",
            "username": "string",
            "subdomain": "string",
            "profilePicture": null,
            "banner": null,
            "bot": false,
            "presence": 0,
            "flags": "string",
            "badges": [],
            "userStatus": {
                "content": null,
                "emojiId": null
            },
            "userRPC": {
                "type": null,
                "name": null,
                "id": null,
                "startedAt": null
            },
            "connections": [],
            "createdAt": "CURRENT_TIMESTAMP",
            "lastOnline": "CURRENT_TIMESTAMP",
            "system": false
        },
        "attachments": [
            {
                "url": "string"
            }
        ],
        "emojis": [
            {
                "emojiId": "string"
            }
        ],
        "mentions": {
            "users": [
                "string"
            ]
        },
        "reactions": [
            {
                "emojiId": "string",
                "count": 0,
                "users": [
                    {
                        "userId": "string",
                        "timestamp": "2019-08-24T14:15:22Z"
                    }
                ]
            }
        ],
        "createdAt": "2019-08-24T14:15:22Z",
        "editedAt": "2019-08-24T14:15:22Z"
    }
]
Modified at 2025-06-19 12:38:15
Previous
Set a team's category priority
Next
Create Announcement
Built with