KObjects (Custom Objects)

Get KObject (custom object) by ID

Retrieves a KObject (custom object) based on the unique KObject ID.

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

Legacy RoleEquivalent Permission Set Role
org.user.kobject.readorg.permission.kobject.read
org.permission.kobject.kobject_*.read
get/klasses/{name}/{id}

Request

  • Base URL: https://api.kustomerapp.com/v1
  • URL: https://api.kustomerapp.com/v1/klasses/{name}/{id}
  • Auth: httpBearer (a scheme the document does not define)

Path parameters

namestring required
Example:orders

Klass name of the KObject.

idstring required
Example:5826ab180fcc2514008b2a94

Unique ID of the KObject.

Response

OK

Example response

{
  "data": {
    "attributes": {
      "firstDone": {
        "time": 27122,
        "businessTime": 27122,
        "createdAt": "2021-06-01T12:00:00Z",
        "createdBy": "60b6b1b3b3b3b3b3b3b3b3b3",
        "createdByTeam": "60b6b1b3b3b3b3b3b3b3b3b3",
        "assignedTeam": "60b6b1b3b3b3b3b3b3b3b3",
        "assignedUser": "60b6b1b3b3b3b3b3b3b3b3",
        "commentCount": 1
      },
      "lastDone": {
        "time": 27122,
        "businessTime": 27122,
        "createdAt": "2021-06-01T12:00:00Z",
        "createdBy": "60b6b1b3b3b3b3b3b3b3b3b3",
        "createdByTeam": "60b6b1b3b3b3b3b3b3b3b3b3",
        "assignedTeam": "60b6b1b3b3b3b3b3b3b3b3",
        "assignedUser": "60b6b1b3b3b3b3b3b3b3b3",
        "commentCount": 1
      },
      "queue": "60b6b1b3b3b3b3b3b3b3b3b3",
      "assignedUser": "60b6b1b3b3b3b3b3b3b3b3",
      "status": "open"
    }
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.