Employee Data Fields API Reference

Introduction

The PerformYard Employee Data Fields API allows customers to programmatically retrieve the list of defined custom data fields for employees.  You can learn more about employee data fields here.

Calling this API endpoint requires an API Key and API ID.  See Getting Started with PerformYard API for details on creating API keys and  API Authentication for authentication flow.

Retrieving the list of Employee Data Fields

This API Endpoint will return the list of defined employee data fields as they are currently defined in PerformYard.  You can learn more about employee data fields here.

HTTP GET

https://api.talent.performyard.com/v1/admin/data-fields/employee
Query Params Type Description Default Example
limit number The number of data fields returned. 200 50
offset number The position of a data field record to return. 0 5
sort string The order in which data fields are returned. Accepts "asc(FIELD_NAME)" and/or "desc(FIELD_NAME)". Optional asc(is_required), desc(type)
type enum The type of data fields returned. Allowed values: department, phone, person, monetary, numeric, email, single-select, textbox, text, multi-select, people, date Optional text
visible string The permission required to view the data field.  Allowed values: self, manager, admin, all Optional all
editable string The permission level required to edit the data field.  Allowed values: self, manager, admin, all
 Optional admin
tags string The tags assigned to the data field Optional
employment

CURL Example

curl --location 'https://api.talent.performyard.com/v1/admin/data-fields/employee?limit=200&offset=0' \
--header 'Accept: application/json' \
--header 'x-api-id: {{X-API-ID}}' \
--header 'x-api-key: {{X-API-KEY}}'

Response 

HTTP 200 OK

Body
{
  "employeeDataFields": [
    {
      "_id": {},
      "type": "monetary",
      "name": "<string>",
      "tags": [
        "<string>",
        "<string>"
      ],
      "created_at": "<string>",
      "is_required": "<boolean>",
      "class": "custom",
      "visible_by": [
        "self",
        "all"
      ],
      "editable_by": [
        "all",
        "manager"
      ]
    },
    {
      "_id": {},
      "type": "date",
      "name": "<string>",
      "tags": [
        "<string>",
        "<string>"
      ],
      "created_at": "<string>",
      "is_required": "<boolean>",
      "class": "custom",
      "visible_by": [
        "manager",
        ...
      ],
      "editable_by": [
        "all",
        "manager"
      ]
    }
  ]
}
Headers
content-type application/json

Related Articles