neosourceDocs
Search docs

Get a team by its key within a workspace

GET/api/workspaces/{workspace}/teams/{key}

getTeamByKey

Resolves the `ENG` in `ENG-7` — team keys are unique per workspace.

Authentication is not described for this operation in the spec — that does not mean it is public. Check tokens and scopes.

curl

curl -X GET 'https://neosource.dev/api/workspaces/WORKSPACE/teams/KEY'

fetch

fetch("https://neosource.dev/api/workspaces/WORKSPACE/teams/KEY", {
  method: "GET",
});

Path parameters

workspacerequired

string

keyrequired

Team key (short uppercase identifier, e.g. `ENG`).

string

Responses

200Team

application/json

TeamResponse

object

is_defaultrequired

boolean

issue_sequencerequired

integerint32

keyrequired

string

namerequired

string

team_idrequired

string

workspace_idrequired

string

403Forbidden — one of: forbidden, needs_scope

application/json

one of
  • ErrorForbidden

  • NeedsScopeError

    object

    `403` body returned when listing private repos but the linked identity lacks the required provider scope. The SPA turns this into an incremental-authorization prompt (Tier 2) that calls the `/elevate` OAuth endpoint with this `scope`.

    errorrequired

    string

    Always `needs_scope` — this body exists to carry the extra fields that kind needs.

    "needs_scope"

    scoperequired

    string

    The provider scope to request via elevation (e.g. `"repo"`).

Standard errors

Bodies documented once for the whole API — see standard errors.

  • 400Bad Request — one of: invalid_input
  • 404Not Found — one of: not_found
  • 429Rate limited — retry after the `Retry-After` header
  • 500Internal server error
  • 503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
  • 504Gateway timeout — the request exceeded the server's handling budget