Kantata Kantata OX Knowledge Base
Release Notes
Status Page

Skill Categories

A Skill Category represents the classification for a group of skills. Options are 'Skill', 'Language', 'Certification', and 'Other'.

Skill categories are defined by Kantata OX and cannot be modified or deleted.

Fetching a list of Skill Categories

This endpoint returns structured Skill Category objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the skill_categories top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • skills (Skill) - The skills associated with each skill category.
matching
string

Skill category names that are like the specified name.

only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

order
string
Default: "alphabetical:asc"

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: alphabetical:asc and alphabetical:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
Responses
200

A list of Skill Categories have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/skill_categories
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "skill_categories": {
    },
  • "skills": {
    }
}