Teamly API
  1. Users
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
    • 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
      • Get Logged In User
        GET
    • 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
  • Schemas
    • Message
    • Message Embed
    • Channel
    • Direct Message
    • To-do Item
    • Application
    • Emoji
    • Team
    • User
    • Role
    • Webhook
    • Blog
    • Category
  • 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
    • Connecting via WebSocket
  1. Users

Get User By Id

GET
https://api.teamly.one/api/v1/users/{userId}

Request

Path Params
userId
string 
required
Header Params
Authorization
string 
optional
Example:
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/users/' \
--header 'Authorization: Bot {token}'

Responses

🟢200Success
application/json
Body
user
object (User) 
required
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
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
Example
{
  "user": {
    "id": "2d5c6531b2ac0fbc",
    "username": "Arda",
    "subdomain": "null",
    "profilePicture": "https://s3-eu-central-1.amazonaws.com/www.teamly.one/userAvatar/c620a99d-6d62-4db3-b69b-3f465eabf311.webp",
    "banner": "https://s3-eu-central-1.amazonaws.com/www.teamly.one/userBanner/c8ed1f6d-65bc-44e5-bfd8-210d649f1cf2.webp",
    "bot": false,
    "system": false,
    "presence": 3,
    "badges": [
      {
        "id": "3e9f6e7cb353fa21",
        "name": "Engineer",
        "icon": "https://s3-eu-central-1.amazonaws.com/www.teamly.one/badges/7cd7449f2d3275c4.webp"
      }
    ],
    "connections": [],
    "createdAt": "2024-11-14T20:50:56.402Z",
    "lastOnline": "2024-12-29T21:38:37.233Z"
  }
}
Previous
Update a Team Role
Next
Get Logged In User
Built with