---
title: "Retrieve an Ecommerce API key or PAKMS key"
method: GET
path: "/pakms/apikey"
tags: ["KEYS"]
---

# Retrieve an Ecommerce API key or PAKMS key

`GET /pakms/apikey`

**Prerequisite: **[Generate an OAuth API token or access_token](https://docs.clover.com/dev/docs/generate-an-oauth-api-token-or-access_token). 

**Description: **Retrieves the public Ecommerce API key associated with a specific merchant and developer app. The <<glossary:merchantId>> and App ID are available in the OAuth API token or `access_token`. 

**Tutorial: **[Generate an Ecommerce API key (PAKMS key)](https://docs.clover.com/dev/docs/generate-ecommerce-api-key-or-pakms-key).

**Next step: **Use the Ecommerce API key for tokenization. See [Ecommerce tokenization overview](https://docs.clover.com/dev/docs/ecommerce-tokenization-overview).

## Query parameters

- `tokenAssociationGroupUuid` string

## Headers

- `User-Agent` string, required

## Response `200`

Successful response. API key is displayed.

- object — API Access Key.
  - `active` boolean — Indicates whether the API key is active. Values: True False
  - `apiAccessKey` string — API key associated with the merchant and developer application.
  - `createdTime` integer, nullable — Time when the API key was created.
  - `developerAppUuid` string — Unique universal identifier (UUID) of the developer app.
  - `merchantUuid` string — Unique universal identifier (UUID) of the merchant. Also known as merchant ID (mId).
  - `tokenAssociationGroupUuid` string — Unique universal identifier (UUID) of the token association group.
  - `modifiedTime` integer, nullable — Time when the API key was modified.

---

[API](https://skmtc.net/clover/apis/platform-api.md) · [All operations](https://skmtc.net/clover/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clover/platform-api/revisions/08da265101a3/schema)