Teams

Teams are the agencies a user can act in. Many write endpoints, including client and risk profile creation, use the user's current team. This endpoint lists every team the user belongs to.

The team model

The response is a JSON array. It is not wrapped in data.

Properties

  • Name
    id
    Type
    integer
    Description

    Unique identifier for the team. Pass this as team_id when listing risk profiles for one team.

  • Name
    name
    Type
    string
    Description

    The team name.

  • Name
    user_id
    Type
    integer
    Description

    Identifier of the team owner.

  • Name
    personal_team
    Type
    boolean
    Description

    Whether this is the user's personal team.

The payload also includes other team settings. Use id and name to choose a team. Do not store credential fields from this response.

GET/api/teams

List teams

Returns every team the authenticated user belongs to.

Request

GET
/api/teams
curl https://app.riskadvisor.insure/api/teams \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"

Response

[
  {
    "id": 3,
    "name": "McCallister Insurance",
    "user_id": 7,
    "personal_team": false
  }
]