Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

Skill Memberships

Skill Memberships represent skills that has been assigned to a specified user.

Fetching a list of Skill Memberships

Returns a list of viewable skill memberships.

This endpoint returns structured Skill Membership 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_memberships top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
active_account_members_only
boolean
Default: false

Only skill memberships for only active users on the account.

by_skill_id
integer <int32>

Only includes associated skill, by the skill ID.

by_skill_ids
string

Only includes associated skills. Input is a comma separated list of ids or an array.

by_skill_name
string

Only includes associated skills, by the name of the skill.

by_user_name
string

Only includes skill memberships assigned to a user, by their full name.

created_after
string <date-time>

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_before
string <date-time>

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

include
string

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

  • creator (User) - References the user who has created the skill association.
  • skill (Skill) - References the skill assigned to the object.
  • user (User) - References the user who has been assigned the skill.
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: "created_at:desc"

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

Valid values: created_at:asc, created_at:desc, full_name, skill_name:asc, and skill_name:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
updated_after
string <date-time>

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_before
string <date-time>

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

user_ids
Array of integers <int32>

Only includes skill memberships assigned to a user, by user ID.

Responses
200

A list of Skill Memberships have been retrieved.

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

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/skill_memberships
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "skill_memberships": {
    },
  • "skills": {
    },
  • "users": {
    }
}
Creating a new Skill Membership
This endpoint returns structured Skill Membership 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_memberships 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.


    

  • creator (User) - References the user who has created the skill association.
    • 

  • skill (Skill) - References the skill assigned to the object.
    • 

  • user (User) - References the user who has been assigned the skill.
    • 



 
Request Body schema: application/json
required
object
 
skill_id
required
integer <int32> 
The ID of the skill.


 
user_id
required
integer <int32> 
The ID of the user.


 
level
integer <int32> 
The user's proficiency level in the skill (1-5). This defaults to 0 if it is not specified.
Note: Not all skills have levels.


 
Responses 
200
Skill Membership has been created.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/skill_memberships
Request samples 
application/json
{
  • "skill_membership": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "skill_memberships": {
    },
  • "skills": {
    },
  • "users": {
    }
}
Fetching a single Skill Membership
Returns a list of viewable skill memberships.


This endpoint returns structured Skill Membership 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_memberships top-level JSON key.
Please see our Response Format section for more information.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
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.


    

  • creator (User) - References the user who has created the skill association.
    • 

  • skill (Skill) - References the skill assigned to the object.
    • 

  • user (User) - References the user who has been assigned the skill.
    • 



 
Responses 
200
The Skill Membership has been retrieved.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/skill_memberships/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "skill_memberships": {
    },
  • "skills": {
    },
  • "users": {
    }
}
Updating an existing Skill Membership
This endpoint returns structured Skill Membership 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_memberships top-level JSON key.
Please see our Response Format section for more information.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
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.


    

  • creator (User) - References the user who has created the skill association.
    • 

  • skill (Skill) - References the skill assigned to the object.
    • 

  • user (User) - References the user who has been assigned the skill.
    • 



 
Request Body schema: application/json
required
object
 
level
integer <int32> 
The user's proficiency level in the skill (1-5). This defaults to 0 if it is not specified.
Note: Not all skills have levels.


 
Responses 
200
Skill Membership has been updated.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/skill_memberships/{id}
Request samples 
application/json
{
  • "skill_membership": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "skill_memberships": {
    },
  • "skills": {
    },
  • "users": {
    }
}
Deleting an existing Skill Membership
Returns a list of viewable skill memberships.


The response will contain no content and an HTTP 204 status code if the request was
successful, or a standard Kantata OX error message explaining why the object could not be deleted.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Responses 
204
Skill Membership has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/skill_memberships/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Skills