customFields.fetch (Implemented by Partner)

The API for listing custom fields that can be synced to Ashby — implemented by the assessment partner, but called by Ashby.

This endpoint is optional. Ashby only calls it for integrations that have custom field sync enabled by Ashby. Contact Ashby if you wish to use this feature.

Once enabled, Ashby fetches your custom field definitions in three situations, not in real time as assessments are created:

  • On demand, when an Ashby admin clicks "Sync Custom Fields" on the integration settings page.
  • When an admin opens the custom fields settings page and Ashby has no field definitions stored for the integration.
  • On a schedule, automatically about once an hour.

Because syncing is periodic rather than per-assessment, new or changed fields on your side may take up to an hour to appear in Ashby unless an admin syncs manually.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json