performance
goal

List all goals

Changed on

Returns a list of PerformanceGoals. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/performance/{connection_id}/goal

Request

  • Base URL
    https://api.unified.to
  • URL
    https://api.unified.to/performance/{connection_id}/goal
  • Auth
    API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

user_idstring

The user/employee ID to filter by (reference to HrisEmployee)

cycle_idstring

The performance cycle ID to filter by

parent_idstring

The parent ID to filter by

typestring
fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
descriptionstring
user_idsstring[]

HR Employees that own or share this goal; the first element is the primary owner

company_idstring
parent_idstring

id of the parent goal, for goal alignment / OKR trees

cycle_idstring

pointer to the Performance Cycle object (goal cycle or timeframe)

type'INDIVIDUAL' | 'TEAM' | 'DEPARTMENT' | 'COMPANY' | 'OTHER'
status'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'CLOSED' | 'OTHER'
progressnumber

progress percentage from 0 to 100

weightnumber

the weight of this goal when the provider weighs goals in reviews

start_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

due_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

completed_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status