Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Get KObjects

Retrieves a KObject by Klass Name.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.klass.read|org.permission.klass.read| |org.admin.klass.read||

Input

type: object properties: parameters: type: object properties: name: type: string description: (Required) Klass name of the KObjects. required: - name title: Parameters

Output

type: object properties: meta: type: object properties: pageSize: type: string page: type: string data: type: array items: 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 links: type: object properties: self: type: string first: type: string prev: type: string next: type: string