KObjects (Custom Objects)

Get KObjects (custom objects)

Retrieves a KObject (custom object) based on the Klass name.

To learn more, see Data Model Overview.

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

Legacy RoleEquivalent Permission Set Role
org.user.klass.readorg.permission.klass.read
org.admin.klass.read
get/klasses/{name}

Request

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

Query parameters

fromDatestring date-time
Example:2016-11-09T00:00:00.000Z

date-time string in Internet Date/Time format (ISO 8601).

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 1 revision of this API.