---
title: "Retrieve the current key or connection"
method: GET
path: "/v1/me"
tags: ["me"]
---

# Retrieve the current key or connection

`GET /v1/me`

## Request

- Base URL: `https://api.formcarry.com`
- URL: `https://api.formcarry.com/v1/me`
- Auth: HTTP bearer

Returns the key or app connection used for this request: its scopes, and which teams and forms it can access. Handy to check what a credential is allowed to do.

## Response `200`

- MeResponse
  - `type` 'key' | 'app', required: key: an API key; app: an OAuth connection
  - `key` MeKey, required
    - `id` string, required
    - `name` string, required
    - `prefix` string, required
    - `last4` string, required
    - `kind` 'standard' | 'legacy', required: standard: made on the API keys page. legacy: the team's original key, kept working under the same secret.
  - `app` MeApp, required
    - `id` string, required: OAuth client id
    - `name` string, required
  - `scopes` string[], required: Union of the per-team scopes
  - `teams` MeTeam[], required: Every team this credential can act on, with its own scopes
    - `id` string, required
    - `name` string, required
    - `scopes` string[], required
    - `form_access` MeFormAccess, required
      - `mode` 'all' | 'list', required: all: every form of the team. list: only the forms listed in forms.
      - `forms` string[], required: The forms this key is limited to, when mode is list

## Other responses

- `401`: The request carried no usable key or token.
- `403`: The key is valid but may not do this.
- `429`: Slow down and retry after the Retry-After header.

---

[API](https://skmtc.dev/formcarry/apis/formcarry-api.md) · [All operations](https://skmtc.dev/formcarry/apis/formcarry-api/llms.txt) · [OpenAPI document](https://skmtc.dev/formcarry/apis/formcarry-api/revisions/c971f37d5987?raw)