Custom Fields are supported in the API. When enabled in AssignmentPro, Custom Fields will be available as attributes on their parent objects, like Assignment or Employee, for GET, POST and PATCH (Read, Create and Update) requests:
Example of three Custom Fields tied to an Assignment record in AssignmentPro
Example of the three Custom Fields in Swagger
In order to return Custom Fields using query string parameters to return a subset of attributes available on the object, the field name must be prefixed with "customFields".
Example of a query string to return the three Custom Fields linked to the Assignment. All enabled Custom Fields will be returned by default.
If a POST or PATCH request is made and includes an attribute for a Custom Field that is not enabled, an error will be generated and returned to the API Consumer.
Things to Note
For enabled Custom Fields that are configured to behave as money - with an Amount and Currency - a corresponding Currency attribute will now be available for requests
When a currency is populated, it is shown in responses, else null is shown when no currency is provided