Skip to content
/
Lists merchant API keys

Lists merchant API keys

Request

GET {{baseURL}}/v2/api-keys

This endpoint lists merchant's API keys.

See Also:
To create an API key, see POST /v2/api-keys.
To revoke an API key, see DELETE /v2/api-keys/{{clientId}}.

Security
Bearer
Query
merchantIdstring, (uuid)

Specifies a merchant identifier to filter API keys.

If the API token used for this endpoint was created from a partner API key, all merchant API keys associated from that partner will be searched. A value for merchantId may be used to limit the search to a specific merchant.

If the API token used for this endpoint was created from a merchant API key, only API keys for that merchant will be returned. A value for merchantId may be omitted.

Example:merchantId=8db2ff47-b143-4adb-ab58-a4a017504db2
curl -i -X GET \
  'https://sandbox.api.flute.com/v2/api-keys?merchantId=8db2ff47-b143-4adb-ab58-a4a017504db2' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
apiKeysArray of objects or null

An array of the merchant's API keys.

Response
{
  "apiKeys": [
    {
      "clientId": "80bb3659-9a62-470b-92f5-d8c5d16d47b0",
      "merchantId": "886e77d0-e86f-4710-92f6-e2b84b29bd9e",
      "apiKeyName": "Production API Key"
    },
    {
      "clientId": "7f191870-7de7-495a-9037-fabeefbdd089",
      "merchantId": "9040dc53-46e3-4816-b3b3-c83d885c2b07",
      "apiKeyName": "Staging API Key"
    }
  ]
}