API Custom Fields endpoint

About API Custom Fields

The new Custom Fields API endpoint (opens in a new window/tab) offers organisations a unique way of managing their HR data more meaningfully, allowing them to retrieve and update their custom data more effectively.

With this feature, you can effortlessly track critical data for your organisation. Learn more about custom fields within the system.

This topic explains how to retrieve custom field values from all or individual employees (GET), and how to update existing custom field data for each employee (PUT).

Step 1 : Create an API User

  1. Sign in to Staffology HR.

  2. If you have not already, create an API user.

  3. Complete the authentication process.

Step 2: Retrieve Custom Field Values (GET)

All employees

  1. To retrieve custom field values for all employees, make a GET request to https://customfields.hrapi.co.uk/ (opens in a new window/tab).

Individual employees

  1. To retrieve custom field values from an individual employee, make a GET request to: https://customfields.hrapi.co.uk/{employeeId} (opens in a new window/tab).

    • Remember to replace {employeeId} with the unique ID of the employee whose date you want to retrieve.

      You can find the unique employeeid by calling our employee endpoint (opens in new window/tab).

Step 3: Update Existing Custom Fields (PUT)

  1. To update existing custom fields for an individual employee, make a PUT request to: https://customfields.hrapi.co.uk/{employeeid}

    • Make sure to replace {employeeId} with the appropriate employee's ID. The request body should contain the entire model in JSON format. If you do not supply existing values, they will be overwritten with NULL.

Troubleshooting and Additional Support

To view a complete mapping of custom fields and their corresponding labels in the system:

  1. Sign in to Staffology HR.

  2. Go to System Tools > Utilities > Tools > Screen Builder.

  3. Make a note of which screen the custom field appears.

If you encounter any issues or need further clarification while using this new Custom Fields API endpoint, our dedicated support team are on hand to help. Find out how to create a support ticket.

We also value your feedback! Do not hesitate to share your experience with the new API.