Klasses

Get Klasses

Retrieves all Klasses.

Filter by status

You can filter results based on the status of the Klass. Valid values are enabled, existing_only, and disabled. The default value is enabled.

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

Request

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

Query parameters

pageSizenumber
Example:100

Number of results to return per page. Default value: 100.

pagenumber
Example:1

Number of pages to return for results. Default value: 1.

status'enabled' | 'disabled' | 'existing_only'
Example:enabled

Option to filter Klass based on the status. Default value: enabled.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.