Get team profile by id or slug

GET

/api/v1/teams/{team}/profile

curl --request GET \
  --url https://api.deploybase.eu/api/v1/api/v1/teams/example/profile \
  --header 'Authorization: <Authorization>'

Identical to GET /api/v1/team/profile, addressed by the team’s UUID or URL slug. The path team must be a team you are a member of; any other team is 403 (a team that does not exist at all is 404). A slug the team has renamed away from still resolves for 30 days: the response is the same 200, plus a Deprecation: true header and a Link: <...>; rel="canonical" header pointing at the current slug, so a client can learn the new name and update its bookmark.

Authorizations

• BearerAuth

Parameters

Path Parameters

team

required

string

Team UUID or slug

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

display_label

DisplayLabel is what to show a human. Never empty, even for the teams whose name is still a Zitadel org UUID.

string

id

string

name

string

slug

string

slug_chosen_at

SlugChosenAt is nil while the slug is still the one we auto-picked. That nil is what drives the settings nudge, so it is part of the response, not an internal detail.

string

Example ^generated

{
  "data": {
    "display_label": "example",
    "id": "example",
    "name": "example",
    "slug": "example",
    "slug_chosen_at": "example"
  },
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

Headers

Deprecation

string

True, when the request used a retired slug

Link

string

Canonical URL of this resource under the team’s current slug

401

Unauthorized

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

403

Forbidden

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

Not Found

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}