API Reference
API Reference

/requisitions/custom_attributes

Returns the field metadata of the account's requisition custom attributes. Required scope: r_requisitions. Accessible with all token types for accounts with Hiring Plan.

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

Results

Calling the /requisitions/custom_attributes endpoint will return the field metadata of the account's requisition custom attributes.

📘

Choices are fetched separately

This endpoint does not return the choices of dropdown and multiple_choice attributes. Use /requisitions/custom_attributes/:id/choices to fetch the allowed choices of a specific attribute.

keytypedescription
custom_attributesarrayArray of requisition custom attributes

Each requisition custom attribute will have the following keys:

keytypedescription
idstringThe requisition custom attribute identifier
slugstringThe key used to set the attribute's value when creating or updating a requisition
typestringThe field type. Can be one of short_text, free_text, bulleted_list, numeric, boolean, date, dropdown, multiple_choice, file, salary, salary_range, signature.
enabledbooleanWhether the attribute is enabled for the account
labelstringThe label of the attribute
Responses

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