List Employee Competencies

get/accounts/{accountId}/employees/{employeeId}/competencies

Returns a list of all competencies assigned to a record in an account for the authenticated user.

Scope: read:employees:training

Request

Path Parameters

NameTypeRequiredExampleDescription
accountIdstringrequired4eb62cb48c9f429c93bc26664c1a5a4d

Unique identifier of an account.

employeeIdstringrequiredb48c9f429c93bc26664c1a5a4d1273

Unique identifier of an employee within an account.

Query String Parameters

NameTypeRequiredExampleDescription
filterstringoptionalname:Scottie*

A search string that contains field:values together with boolean operators, which can be used to filter the result.

An asterix (*) can also be used as a wildcard for partial matches on words. Logical operators (AND and OR) can be used between terms. Terms can be grouped via parenthesis to build complex search queries (see examples below).

The fields used in the field must be fields returned from the REST API endpoint.

Some example filters:

  • firstName:John which would return employees whose firstName was John.
  • surname:Smith OR surname:Klein which would return employees whose surname was either Smith or Klein.
  • surname:Smi* which would return employees whose surname is Smith, Smits, Smithe, etc.
  • type:LegalEntity AND postcode:2000 which would return all branches that are Legal Entities and in postcode 2000.
  • postcode:2000 OR postcode:3000 which would return all branches in either postcode of 2000 or in postcode 3000.
  • type:LegalEntity AND (postcode:2000 OR postcode:3000) which would return all branches that are Legal Entities and in postcode 2000 or 3000.
  • Date filter:
    • Date range inclusive: dateUpdatedUTC:[2021-01-01 TO 2021-12-31]
    • Date range exclusive: dateUpdateUTC:{2021-01-01 TO 2021-12-31}
    • Unbounded range: dateUpdatedUTC:{* TO 2021-01-01}
sortarrayoptionalsort=name:asc&sort=type:desc

WIP Description

Specify the field, followed by asc/desc, separated by :

firstintegeroptional100

WIP Description

Pagination: Indicates the number of items that would be in the results. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

afterstringoptional342dfs09ds329320

WIP Description

Pagination: Start Cursor for the requested Page. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

lastintegeroptional100

WIP Description

Pagination: Indicates the number of items that would be in the results NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

beforestringoptional531dfs09ds332932

WIP Description

Pagination: End Cursor for the requested Page. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

Responses

The request was successful, the response contains an array of competencies assigned to the Record (in summary form) in the account, wrapped in pagination information.
© 2022 enableHR · All rights reserved