In this guide, you'll learn how to create and manage custom fields in your system. Custom fields help you tailor the system to your specific needs.
Navigating to the Custom Field Section
Go to the custom field section to get started.
Creating a New Custom Field
Click New Field to start creating a custom field.
For instance, if you're creating an employee_type field, use snake_case for the name.
Add a brief description and select a category, such as HRIS or ATS.
Choose the model where the custom field will be added. Once selected, click Create to finalize the addition.
Choosing Options for the Custom Field
You'll see two options: connector or organization (integration-specific). For simplicity, select organization.
If you're working with Personio, you can either pick from the drop-down menu or view the raw data and choose from there.
Finalizing the Custom Field
Click OK, then click Create. Your custom field is now ready.
Retrieving Custom Field Data
To retrieve data from the custom field, set the include_custom_fields parameter to true. Use the endpoint for the selected model and include this parameter in your request.
eg.
https://api.bindbee.dev/api/hris/v1/employees?include_custom_fields=true
Creating Connector-Specific Custom Fields
To create a connector-specific custom field, select a connector.
For example, if you're using Personio and have already created an organization-level mapping, the connector-level mapping will override it. Choose a different field, such as the label, and click OK.
Updating and Editing Custom Fields
Call the URL to see updated data. For instance, if the previous data showed "employee," it might now show the ID value. Edit the custom field by clicking the pencil icon.
Choose the correct mapping and click ok. The API will now return the updated data.
Deleting Custom Fields or Mappings
If you don't need a specific mapping, delete it.
You can also delete the custom field entirely.
Learn more about custom fields here.