Get a team

GET

/v1/teams/{id}

const url = 'https://proficient-seahorse-829.eu-west-1.convex.site/v1/teams/team_jn7fw41m8n5jtht7hxsy69tzg97gvef8';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://proficient-seahorse-829.eu-west-1.convex.site/v1/teams/team_jn7fw41m8n5jtht7hxsy69tzg97gvef8 \
  --header 'Authorization: Bearer <token>'

Retrieves a single team.

Authorizations

apiKey

Parameters

Path Parameters

required

Team ID

string

>= 1 characters

Example

team_jn7fw41m8n5jtht7hxsy69tzg97gvef8

Team ID

Responses

200

The team

application/json

object

required

string

name

required

string

account_id

required

string

role

required

The caller’s role on this team.

string | null

Allowed values: admin member

created_at

required

number

Example

{
  "id": "team_jn7fw41m8n5jtht7hxsy69tzg97gvef8",
  "name": "Brand team",
  "account_id": "acc_jh716ctpaqbye9aw64tgkqwtks7gvx7g",
  "role": "admin",
  "created_at": 1748875980
}

404

Team not found

application/json

object

error

required

string

Example

{
  "error": "Render not found"
}