> For the complete documentation index, see [llms.txt](https://documentation.proto.cx/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.proto.cx/docs/developers/apis/teams-api.md).

# Teams API

Resolve a [team](/docs/settings/general/teams.md) from a name, for routing conversations to the right team.

***

### [**Find a team by name**](https://v3-api.proto.cx/api/platform/v1/docs#/v1/get_team_by_name_v1_teams__subcompany_id__get_team_by_name_post)

Finds [teams](/docs/settings/general/teams.md) matching a name. **top\_k** caps how many matches are returned and **score\_threshold** sets the minimum match score, so close matches and misspellings still resolve.

{% code title="URL" overflow="wrap" %}

```
POST https://v3-api.proto.cx/api/platform/v1/teams/{subcompany_id}/get-team-by-name
```

{% endcode %}

**Query parameters**

| Parameter         | Required | Type    |
| ----------------- | -------- | ------- |
| `top_k`           | No       | integer |
| `score_threshold` | No       | number  |

{% code title="Body" overflow="wrap" %}

```
{
  "name": "string" (required)
}
```

{% endcode %}
