API Keys

Get API keys

Changed on

Returns a list of API keys.

<div> <code>read:api_keys</code> </div>
get/api/v1/api_keys

Request

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

Query parameters

page_sizeinteger nullable

Number of results per page. Defaults to 50 if parameter not sent.

starting_afterstring nullable

The ID of the API key to start after.

key_type'organization' | 'user' nullable

Filter by API key type (organization or user).

status'active' | 'inactive' | 'revoked' nullable

Filter by API key status (active, inactive, revoked).

user_idstring nullable

Filter by user ID to get API keys associated with a specific user.

org_codestring nullable

Filter by organization code to get API keys associated with a specific organization.

Response

API keys successfully retrieved.

codestring

Response code.

messagestring

Response message.

has_moreboolean

Whether more records exist.

Example response

{
  "code": "OK",
  "message": "Success",
  "api_keys": [
    {
      "id": "api_key_0195ac80a14e8d71f42b98e75d3c61ad",
      "name": "My API Key",
      "type": "organization",
      "status": "active",
      "key_prefix": "kinde_",
      "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"
      ]
    }
  ]
}

Changes