Kustomer API
Getting access, Developing, Testing
Back to Kustomer
Get KObject
Retrieves a KObject using its unique ID.
Any one of the following roles is required for this endpoint:
|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.kobject.read|org.permission.kobject.read| ||org.permission.kobject.kobject_*.read|
Input
type: object
properties:
parameters:
type: object
properties:
name:
type: string
description: (Required) Klass name of the KObject.
id:
type: string
description: (Required) Unique ID of the KObject.
required:
- name
- id
title: Parameters
Output
type: object
properties:
data:
type: object
properties:
type:
type: string
id:
type: string
attributes:
type: object
properties:
title:
type: string
icon:
type: string
images:
type: array
items:
type: string
custom:
type: object
properties:
orderStatusStr:
type: string
shippingStatusStr:
type: string
billingStatusStr:
type: string
specialInstructionsStr:
type: string
orderNumberNum:
type: string
orderDescriptionStr:
type: string
totalPriceNum:
type: string
orderUpdatedAt:
type: string
tags:
type: string
updatedAt:
type: string
createdAt:
type: string
rev:
type: string
relationships:
type: object
properties:
org:
type: object
properties:
links:
type: object
properties:
self:
type: string
data:
type: object
properties:
type:
type: string
id:
type: string
klass:
type: object
properties:
link:
type: object
properties:
self:
type: string
data:
type: object
properties:
type:
type: string
id:
type: string
links:
type: object
properties:
self:
type: string