Check an API key

GET

/api/auth/api-keys/current

curl --request GET \
  --url http://localhost:3000/api/auth/api-keys/current \
  --header 'Authorization: Bearer <token>'

• Your Merran

The key this request was sent with: its household and what it may do. A quick way for a tool like Home Assistant to check its key works. Any API key that works will do: it needs no permission.

Authorizations

• apiKey

Responses

200

The key works.

Media typeapplication/json

object

id

required

string

name

required

string

start

required

string

household

required

object

id

required

string

name

required

string

permissions

required

object

household

string

Allowed values: read

recipes

string

Allowed values: read write

plan

string

Allowed values: read write

list

string

Allowed values: read write

pantry

string

Allowed values: read write

imports

string

Allowed values: read write

assistant

string

Allowed values: read write

expiresAt

required

string | null format: date-time

lastUsedAt

required

string | null format: date-time

createdAt

required

string format: date-time

Example

{
  "id": "0199e8b0-5a10-7a01-8b00-000000000009",
  "name": "Home Assistant",
  "start": "mrn_3fK9aQ",
  "household": {
    "id": "0199e8b0-5a10-7a01-8b00-000000000003",
    "name": "The Riveras"
  },
  "permissions": {
    "recipes": "read",
    "list": "write"
  },
  "expiresAt": "2027-01-13T18:30:00.000Z",
  "lastUsedAt": "2026-10-15T18:30:00.000Z",
  "createdAt": "2026-10-01T17:30:00.000Z"
}

400

No API key was sent.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}

401

The key doesn’t work.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}