List API key metadata (owner only)

GET

/dashboard/v1/merchants/{merchantId}/{mode}/api-keys

curl --request GET \
  --url 'http://localhost:4000/dashboard/v1/merchants/example/test/api-keys?limit=20' \
  --cookie better-auth.session_token=<better-auth.session_token>

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

Query Parameters

limit

integer

default: 20 >= 1 <= 100

starting_after

string

Responses

200

API keys without secrets

Media typeapplication/json

object

object

required

string

Allowed values: list

data

required

Array<object>

object

object

required

string

Allowed values: api_key

id

required

string

mode

required

string

Allowed values: test live

display_prefix

required

string

last_used_at

required

string | null

revoked_at

required

string | null

scheduled_revoke_at

required

string | null

created_at

required

string

has_more

required

boolean

Example

{
  "object": "list",
  "data": [
    {
      "object": "api_key",
      "mode": "test"
    }
  ]
}

400

Invalid request

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Sign-in required

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Forbidden

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Not found

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Idempotency conflict or invalid state

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}