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.

Requirements

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.

Retrieve All Employee Data Fields

GET https://api.talent.performyard.com/v1/admin/data-fields/employee

Returns a list of all defined employee data fields.

Query Parameters

limit integer
The number of employee data fields to be returned in a single API Request.

Default: 200

Minimum: 5

Maximum: 200
offset integer
Used to paginate through the list of employee data fields. Can be combined with limit.

Default: 0

Increment the value by one to fetch subsequent pages (1 for the second page, 2 for the third, etc.).
sort string
Order in which to return the employee data fields.

Allowed Values: asc(FIELD_NAME) desc(FIELD_NAME)

Allowed Field Names: name type
type enum
Filter the returned employee data fields by a specific type.

Allowed Values: department phone person monetary numeric email single-select textbox text multi-select people date

Accepts only a single string value.
visible enum
Filter the returned employee data fields by which permission level can view the data field.

Allowed Values: all self manager admin

Accepts only a single string value.
editable enum
Filter the returned employee data fields by which permission level can edit the data field.

Allowed Values: all self manager admin

Accepts only a single string value.
tags string
Filter the returned employee data fields by the tags that were added to the data fields.

Accepts only a single string value. Case sensitive.

CURL Example

curl --location 'https://api.talent.performyard.com/v1/admin/data-fields/employee?limit=10&offset=0&type=single-select&visible=all&editable=self&tags=employment' \
--header 'Accept: application/json' \
--header 'x-api-id: {{X-API-ID}}' \
--header 'x-api-key: {{X-API-KEY}}'

Response (200)

{
  "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"
      ]
    }
  ]
}

Related Articles