Overview

This node operation retrieves detailed information about a specific custom field definition from the Teamleader API. It is useful when you need to get metadata or configuration details of a custom field used in your Teamleader account, such as its type, options, or other attributes.

Use Case Examples

1. Fetch details of a custom field definition by its ID to understand its properties before using it in other operations or workflows.
2. Use this operation to verify the configuration of a custom field before updating or mapping data to it.

Properties

Output

JSON

• id - The unique identifier of the custom field definition.
• name - The name of the custom field.
• type - The data type of the custom field (e.g., text, number, date).
• options - Possible options or values for the custom field if it is a selectable type.
• required - Indicates if the custom field is mandatory.
• visible - Indicates if the custom field is visible in the UI.

Dependencies

• Teamleader API OAuth2 credentials

Troubleshooting

• Ensure the provided ID is correct and corresponds to an existing custom field definition in Teamleader.
• Check that the OAuth2 credentials are valid and have the necessary permissions to access custom field definitions.
• Common error messages include 'No data got returned' if the ID is invalid or the API response is empty, and authentication errors if credentials are missing or expired.

Links

• Teamleader API Documentation - Official documentation for the Teamleader API, including custom field definitions endpoints.