Skip to content

Skill Memberships

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

Operations

Fetching a list of Skill Memberships

Request

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.

Query
active_account_members_onlyboolean

Only skill memberships for only active users on the account.

Default:false
by_skill_idinteger, (int32)

Only includes associated skill, by the skill ID.

by_skill_idsstring

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

by_skill_namestring

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

by_user_namestring

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

created_afterstring, (date-time)

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

created_beforestring, (date-time)

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

includestring

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.
onlystring

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.

orderstring

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.

Default:"created_at:desc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
updated_afterstring, (date-time)

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

updated_beforestring, (date-time)

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

user_idsArray of integers, (int32)

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

workspace_idinteger, (int32)

Filter for participants of a specific project.

GET
/skill_memberships
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/skill_memberships?active_account_members_only=false&by_skill_id=0&by_skill_ids=string&by_skill_name=string&by_user_name=string&created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&include=string&only=string&order=created_at%3Adesc&page=1&per_page=20&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z&user_ids=0&workspace_id=0'

Responses

A list of Skill Memberships have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
skill_membershipsobject
skillsobject
usersobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "skill_memberships": {
    "property1": {
      "cached_skill_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "level": 0,
      "max_level": 0,
      "skill_id": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    },
    "property2": {
      "cached_skill_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "level": 0,
      "max_level": 0,
      "skill_id": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    }
  },
  "skills": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "external_reference_ids": [
        "string"
      ],
      "max_level": "string",
      "name": "string",
      "skill_category_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "external_reference_ids": [
        "string"
      ],
      "max_level": "string",
      "name": "string",
      "skill_category_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  }
}