Generated by API Evangelist
Written by API Evangelist tooling for Kinde's API. It is a proposal applied on top of the contract, not a document Kinde publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Kinde Properties API
version: 1.0.0
extends: openapi/kinde-properties-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 5
- target: $.paths['/account_api/v1/properties'].get
update:
x-apievangelist-phrasing:
intent: List the signed-in user's properties
effect: read
questions:
- What custom properties are stored for the logged-in user?
- Can my app read the current user's property values?
instructions:
- text: List my properties.
- text: Show the current user's custom properties, {page_size} per page.
slots:
page_size: query.page_size
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/properties'].get
update:
x-apievangelist-phrasing:
intent: List property definitions
effect: read
questions:
- Which custom properties have I defined?
- Can I list only the properties for users or for organizations?
instructions:
- text: List all property definitions.
- text: Show property definitions in the {context} context.
slots:
context: query.context
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/properties'].post
update:
x-apievangelist-phrasing:
intent: Create a custom property
effect: write
questions:
- How do I define a new custom property for users or organizations?
- Can I make a property private so it isn't exposed in tokens?
instructions:
- text: Create a {type} property {name} with key {key} in the {context} context under category {category_id}.
slots:
type: requestBody.type
name: requestBody.name
key: requestBody.key
context: requestBody.context
category_id: requestBody.category_id
- text: Add private property {key} named {name}, type {type}, context {context}, category {category_id}.
slots:
key: requestBody.key
name: requestBody.name
type: requestBody.type
context: requestBody.context
category_id: requestBody.category_id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/properties/{property_id}'].put
update:
x-apievangelist-phrasing:
intent: Update a property definition
effect: write
questions:
- Can I rename a custom property or move it to another category?
- How do I change whether a property is private?
instructions:
- text: Rename property {property_id} to {name} in category {category_id}.
slots:
property_id: path.property_id
name: requestBody.name
category_id: requestBody.category_id
- text: 'Update property {property_id}: name {name}, private {is_private}, category {category_id}.'
slots:
property_id: path.property_id
name: requestBody.name
is_private: requestBody.is_private
category_id: requestBody.category_id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/properties/{property_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a property definition
effect: destructive
questions:
- How do I delete a custom property definition?
- Can I remove a property I no longer use?
instructions:
- text: Delete property {property_id}.
slots:
property_id: path.property_id
- text: Remove the custom property definition {property_id}.
slots:
property_id: path.property_id
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.