Get team by nanoid

GET /v2/teams/{team_nanoid}

Try it

Get team by nanoid

cURL

curl --request GET \
  --url https://b2b-api.dev-riseworks.io/v2/teams/{team_nanoid} \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "data": {
    "nanoid": "<string>",
    "name": "<string>",
    "avatar": "<string>",
    "balance": "<string>",
    "administrators": [
      {
        "relationship_nanoid": "<string>",
        "user_nanoid": "<string>",
        "avatar": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>",
        "type": "team_admin"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_nanoid · string · required

TeamNanoid

Required string length: 15

Response

200

application/json

Default Response

success · enum<boolean> · required

Available options: true, false

data · object · required

Show child attributes

data. nanoid · string · required

Unique identifier for the team.

data. name · string · required

Name of the team.

Minimum string length: 1

data. avatar · string · required

URL of the team avatar.

data. balance · string · required

Current balance of the team.

data. administrators · object[] · required

Show child attributes

data.administrators. relationship_nanoid · string · required

Unique identifier for the relationship of the administrator.

data.administrators. user_nanoid · string · required

Unique identifier for the user.

data.administrators. avatar · string · required

URL of the administrator's avatar.

data.administrators. first_name · string · required

First name of the administrator.

data.administrators. last_name · string · required

Last name of the administrator.

data.administrators. email · string · required

Email address of the administrator.

data.administrators. type · enum<string> · required

Role type of the administrator within the team.

Available options: team_admin, team_finance_admin, team_viewer