GET/projects/api/v3/skills.json

Get all skills.

This returns all skills along installation. You can limit output by provided filters. Default data pagination is 50 items per page. When include users all users that are assigned to that skill will be side loaded

Query Params

Name
updatedBefore
Type
string
Description
filter by updated after date
Name
updatedAfter
Type
string
Description
filter by updated after date
Name
searchTerm
Type
string
Description
filter by search term
Name
orderMode
Type
string
Description
order mode
Default
asc
Allowed values
- asc
- desc
Name
userId
Type
integer
Description
filter by user id
Name
taskId
Type
integer
Description
filter by task id
Name
pageSize
Type
integer
Description
number of items in a page
Default
50
Name
page
Type
integer
Description
page number
Default
1
Name
skipCounts
Type
boolean
Description
SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
Name
showDeleted
Type
boolean
Description
include deleted items
Default
false
Name
updatedByUserIds
Type
array[integer]
Description
filter by updater user id
Format
Comma separated values
Name
projectIds
Type
array[integer]
Description
filter by project ids
Format
Comma separated values
Name
include
Type
array[string]
Description
include
Format
Comma separated values
Allowed values
- users
Name
ids
Type
array[integer]
Description
filter by ids
Format
Comma separated values
Name
fields[users]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- firstName
- lastName
- title
- email
- companyId
- company
- isAdmin
- isClientUser
- isServiceAccount
- type
- deleted
- avatarUrl
- lengthOfDay
- workingHoursId
- workingHour
- userRate
- userCost
- canAddProjects
Name
fields[skill]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- name
Name
createdByUserIds
Type
array[integer]
Description
filter by creator user id
Format
Comma separated values
Name
assignedToUserIds
Type
array[integer]
Description
filter skills by users assigned to it
Format
Comma separated values

Responses

Code
200
Type
object
Schema
Description
200 OK
SkillsResponse contains information about a group of skills.
Code
400
Type
object
Schema
Description
400 Bad Request
ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

SkillsResponse

{
  "included": {
    "users": {
      "additionalProp": {
        "avatarUrl": "string",
        "canAccessPortfolio": true,
        "canAddProjects": true,
        "canManagePortfolio": true,
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "companyId": 0,
        "companyRoleId": 0,
        "createdAt": "string",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deleted": true,
        "email": "string",
        "firstName": "string",
        "id": 0,
        "isAdmin": true,
        "isClientUser": true,
        "isPlaceholderResource": true,
        "isServiceAccount": true,
        "jobRoles": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "lastLogin": "string",
        "lastName": "string",
        "lengthOfDay": 0,
        "meta": {},
        "skills": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "teams": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "timezone": "string",
        "title": "string",
        "type": "string",
        "updatedAt": "string",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "userCost": 0,
        "userRate": 0,
        "userRates": {
          "additionalProp": {
            "amount": 0,
            "currency": {
              "id": 0,
              "meta": {},
              "type": "string"
            }
          }
        },
        "workingHour": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "workingHoursId": 0
      }
    }
  },
  "meta": {
    "averageSpend": 0,
    "limit": 0,
    "nextCursor": "string",
    "page": {
      "count": 0,
      "hasMore": true,
      "pageOffset": 0,
      "pageSize": 0
    },
    "prevCursor": "string",
    "totalCapacity": 0
  },
  "skills": [
    {
      "createdAt": "string",
      "createdByUser": 0,
      "deletedAt": "string",
      "deletedByUser": 0,
      "id": 0,
      "name": "string",
      "updatedAt": "string",
      "updatedByUser": 0,
      "users": [
        {
          "id": 0,
          "meta": {},
          "type": "string"
        }
      ]
    }
  ]
}

Download Swagger