API Keys

Get API key

Changed on

Retrieve API key details by ID.

<div> <code>read:api_keys</code> </div>
get/api/v1/api_keys/{key_id}

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/api_keys/{key_id}
  • Auth: HTTP bearer

Path parameters

key_idstring required

The ID of the API key.

Response

API key successfully retrieved.

codestring

Response code.

messagestring

Response message.

Example response

{
  "code": "OK",
  "message": "Success",
  "api_key": {
    "id": "api_key_0195ac80a14e8d71f42b98e75d3c61ad",
    "name": "My API Key",
    "type": "organization",
    "status": "active",
    "key_prefix": "k_live",
    "key_suffix": "abcd",
    "created_on": "2024-11-18T13:32:03+11",
    "last_verified_on": "2024-11-18T13:32:03+11",
    "last_verified_ip": "192.168.1.1",
    "created_by": "John Doe",
    "api_ids": [
      "api_123",
      "api_456"
    ],
    "scopes": [
      "read:users",
      "write:users"
    ],
    "verification_count": 42,
    "organization_id": "org_123",
    "user_id": "user_456"
  }
}

Changes