MAmanatal
client-fields

GET /client-fields/job/

Return a flat list of the client's job fields, including native and custom fields. Requires the job API scope.

Request

  • Base URL
    https://api.manatal.com/open/v3
  • URL
    https://api.manatal.com/open/v3/client-fields/job/
  • Auth
    API key in header Authorization

Response

idinteger required
namestring required

Display name of the field

descriptionstring required

Description of the field

slugstring required

Stable key used to read and write the field value

field_type'text' | 'long_text' | 'date' | 'number' | 'percentage' | 'boolean' | 'dropdown' | 'multiple_select_dropdown' | 'multiple_choice' | 'checkbox' | 'custom_id' required

Type of value stored by the field

answer_choicesstring[] required

Allowed values for dropdown, multiple choice, and checkbox fields

answer_choice_type'candidate' | 'job' | 'match' | 'organization' | 'text' | 'user' | 'contact' required

Kind of value stored in answer choices

creator_namestring required

Name of the user who created the field

is_nativeboolean required

Whether the field is a built-in Manatal field

is_hiddenboolean required

Whether the field is hidden in Manatal

is_requiredboolean required

Whether a value is required

can_be_hiddenboolean required

Whether the field can be hidden

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.