Skip to content
Coolify's Docs

Get

GET
/teams/{id}

Get team by TeamId.

Authorizations

Parameters

Path Parameters

id
required
integer

Team ID

Responses

200

List of teams.

Team model

object
id

The unique identifier of the team.

integer
name

The name of the team.

string
description

The description of the team.

string
personal_team

Whether the team is personal or not.

boolean
created_at

The date and time the team was created.

string
updated_at

The date and time the team was last updated.

string
smtp_enabled

Whether SMTP is enabled or not.

boolean
smtp_from_address

The email address to send emails from.

string
smtp_from_name

The name to send emails from.

string
smtp_recipients

The email addresses to send emails to.

string
smtp_host

The SMTP host.

string
smtp_port

The SMTP port.

string
smtp_encryption

The SMTP encryption.

string
smtp_username

The SMTP username.

string
smtp_password

The SMTP password.

string
smtp_timeout

The SMTP timeout.

string
smtp_notifications_test

Whether to send test notifications via SMTP.

boolean
smtp_notifications_deployments

Whether to send deployment notifications via SMTP.

boolean
smtp_notifications_status_changes

Whether to send status change notifications via SMTP.

boolean
smtp_notifications_scheduled_tasks

Whether to send scheduled task notifications via SMTP.

boolean
smtp_notifications_database_backups

Whether to send database backup notifications via SMTP.

boolean
smtp_notifications_server_disk_usage

Whether to send server disk usage notifications via SMTP.

boolean
discord_enabled

Whether Discord is enabled or not.

boolean
discord_webhook_url

The Discord webhook URL.

string
discord_notifications_test

Whether to send test notifications via Discord.

boolean
discord_notifications_deployments

Whether to send deployment notifications via Discord.

boolean
discord_notifications_status_changes

Whether to send status change notifications via Discord.

boolean
discord_notifications_database_backups

Whether to send database backup notifications via Discord.

boolean
discord_notifications_scheduled_tasks

Whether to send scheduled task notifications via Discord.

boolean
discord_notifications_server_disk_usage

Whether to send server disk usage notifications via Discord.

boolean
show_boarding

Whether to show the boarding screen or not.

boolean
resend_enabled

Whether to enable resending or not.

boolean
resend_api_key

The resending API key.

string
use_instance_email_settings

Whether to use instance email settings or not.

boolean
telegram_enabled

Whether Telegram is enabled or not.

boolean
telegram_token

The Telegram token.

string
telegram_chat_id

The Telegram chat ID.

string
telegram_notifications_test

Whether to send test notifications via Telegram.

boolean
telegram_notifications_deployments

Whether to send deployment notifications via Telegram.

boolean
telegram_notifications_status_changes

Whether to send status change notifications via Telegram.

boolean
telegram_notifications_database_backups

Whether to send database backup notifications via Telegram.

boolean
telegram_notifications_test_message_thread_id

The Telegram test message thread ID.

string
telegram_notifications_deployments_message_thread_id

The Telegram deployment message thread ID.

string
telegram_notifications_status_changes_message_thread_id

The Telegram status change message thread ID.

string
telegram_notifications_database_backups_message_thread_id

The Telegram database backup message thread ID.

string
custom_server_limit

The custom server limit.

string
telegram_notifications_scheduled_tasks

Whether to send scheduled task notifications via Telegram.

boolean
telegram_notifications_scheduled_tasks_thread_id

The Telegram scheduled task message thread ID.

string
members

The members of the team.

Array<object>

User model

object
id

The user identifier in the database.

integer
name

The user name.

string
email

The user email.

string
email_verified_at

The date when the user email was verified.

string
created_at

The date when the user was created.

string
updated_at

The date when the user was updated.

string
two_factor_confirmed_at

The date when the user two factor was confirmed.

string
force_password_reset

The flag to force the user to reset the password.

boolean
marketing_emails

The flag to receive marketing emails.

boolean

400

Invalid token.

object
message
string
Invalid token.

401

Unauthenticated.

object
message
string
Unauthenticated.

404

Resource not found.

object
message
string
Resource not found.