Teams Resource

Teams are groups of developers on Discord who want to collaborate on apps. On other platforms, these may be referred to as "organizations", "companies", or "teams". Discord went with the name Teams because it best encompassed all the awesome conglomerates of devs that work together to make awesome things on Discord. Also, none of you ever got picked for kickball in gym class, so now you get to be on a team.

Teams allow you and other Discord users to share access to apps. No more sharing login credentials in order to reset the token on a bot that your friend owns but you work on, or other such cases.

For game developers, this means that you can get your engineers access to your app for credentials they may need, your marketing folks access to store page management, and your finance people access to sales and performance metrics.

Team Object

Team Structure

¹ The default team icon uses the same images as default avatars and can be calculated using team_id % 5.

² Only provided in the application object.

³ Only included when fetched from Get Team or Get Teams with include_payout_account_status set to true.

⁴ Only included when fetched from Get Team.

Team Payout Account Status

Example Team

{
  "id": "1110738998453837384",
  "icon": null,
  "name": "Power",
  "owner_user_id": "852892297661906993",
  "payout_account_status": 1
}

Team Member Object

Team Member Structure

Membership State

Team Member Roles

Team members can be one of four roles (owner, admin, developer, and read-only), and each role inherits the access of those below it. Roles for team members can be configured under Team Members in a team's settings.

Team Member Role Types

Example Team Member

{
  "user": {
    "id": "852892297661906993",
    "username": "alien",
    "global_name": "Alien",
    "avatar": "05145cc5646fbcba277b6d5ea2030610",
    "discriminator": "0",
    "public_flags": 64,
    "avatar_decoration_data": null
  },
  "team_id": "1110738998453870732",
  "membership_state": 2,
  "role": "admin"
}

Team Payout Object

Team Payout Structure

Team Payout Status

Example Team Payout

{
  "id": "1110738998453870732",
  "user_id": "852892297661906993",
  "amount": 1000000,
  "status": 1,
  "period_start": "2021-01-01",
  "period_end": null,
  "payout_date": null
}

Company Object

A development/publishing company working on a game on Discord.

Company Structure

Example Company

{
  "id": "1058932127820939295",
  "name": "AlienTec"
}

Endpoints

Get Teams

Returns a list of team objects that the current user is a member of.

Query String Params

Create Team

Creates a new team. Returns a team object on success. Users can join a maximum of 30 teams.

JSON Params

Get Team

Returns a team object for the given team ID.

Modify Team

Modifies a team. User must be an admin of the team. Returns the updated team object on success.

JSON Params

Delete Team

Deletes a team permanently. User must be the owner of the team. Returns a 204 empty response on success.

Accept Team Invite

Accepts an invite to join a team. Returns a team object on success. Users can join a maximum of 30 teams.

JSON Params

¹ This token can be retrieved by visiting the emailed https://click.discord.com/ link and extracting the #token URI fragment from the redirect URL.

Get Team Members

Returns a list of team member objects for the given team ID.

Add Team Member

Invites a user to the team. User must be an admin of the team. Returns a team member object on success.

JSON Params

¹ null for migrated users. See the section on Discord's new username system for more information.

Modify Team Member

Modifies a team member. User must be an admin of the team. Returns the updated team member object on success.

JSON Params

Remove Team Member

Removes a team member. User must be the an admin of the team unless removing themselves. Returns a 204 empty response on success.

Get Team Applications

Returns a list of application objects for the given team ID.

Get Team Stripe Connect URL

Returns a link that can be used to access the team's Stripe Connect payout account dashboard.

JSON Params

Response Body

Example Response

{
  "stripe_connect_redirect_url": "https://connect.stripe.com/setup/e/acct_123456/789abcd"
}

Get Team Payout Onboarding

Returns a link that can be embedded in an IFrame to allow the user to access the team's Tipalti payout account dashboard. User must be the owner of the team.

Response Body

Example Response

{
  "url": "https://ui2.tipalti.com/payeedashboard/home?ts=12345&idap=10418817887227111107389984538707326773&payer=Discord&hashkey=123456abcd"
}

Get Team Payouts

Returns a list of team payout objects for the given team ID.

Query String Params

Get Team Payout Report

Returns a CSV file containing the payout report for the given payout ID.

Query String Params

Team Payout Report Type

Search Companies

Returns a list of company objects that match the given query. If no results are found, returns a 204 empty response.

Query String Params

Create Company

Creates a new company under this team. Returns a company object on success.

JSON Params