Karma Common API
​number · required​string · required​string · minLength: 1 · required​string · enum · required
​number · required​number · required​string · enum · required
​string · minLength: 3 · required​string · enum · required
​number · required​number · required​string · enum · required
Labels and categorization
Create custom tag
POST
https://common-api.karma.life
/api/v1/custom-tags
Create a new custom tag and link it to an item
Permissions: 🟢 custom_tags.create
Create custom tag › Request Body
itemIdItem ID to tag
categoryHandleCategory handle
keyTag key/name
Create custom tag › Responses
Default Response
statusEnum values:
success
​object · required
​object · required
Link custom tag
POST
https://common-api.karma.life
/api/v1/custom-tags/link
Link an existing custom tag to an item
Permissions: 🟠custom_tags.update
Link custom tag › Request Body
itemIdItem ID
customTagIdCustom tag ID to link
Link custom tag › Responses
Default Response
statusEnum values:
success
​object · required
​object · required
Search custom tags
GET
https://common-api.karma.life
/api/v1/custom-tags/search
Search for custom tags by query string
Permissions: 🔵 custom_tags.read
query Parameters
querySearch string (minimum 3 characters)
Search custom tags › Responses
Default Response
statusEnum values:
success
​object[] · required
​object · required
Unlink custom tag
POST
https://common-api.karma.life
/api/v1/custom-tags/unlink
Unlink a custom tag from an item
Permissions: 🟠custom_tags.update
Unlink custom tag › Request Body
itemIdItem ID
customTagIdCustom tag ID to unlink
Unlink custom tag › Responses
Default Response
statusEnum values:
success
​object · required
​object · required