FAfactorialhr
CustomFields > ResourceField

Creates a Resource field

Changed on

Creates an schema custom field

post/api/2026-10-01/resources/custom_fields/resource_fields

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/custom_fields/resource_fields
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: custom_fields
    • or API key in header x-api-key

Request body

schema_idstring required

Schema identifier

company_idstring required

Company identifier

labelstring

Resource field label

field_type'text' | 'long_text' | 'date' | 'rating' | 'checkbox' | 'single_choice' | 'multiple_choice' | 'money' | 'cents' required

Type of the value for the resource field

requiredboolean required

Requirement to fill this resource field

max_valueinteger

Maximum value for range field type

min_valueinteger

Minimum value for range field type

positioninteger

Field position within schema

editable'owned' | 'reportees' | 'team_leader' | 'legal_entity' | 'everybody' required

Group for which this field is editable

visible'owned' | 'reportees' | 'team_leader' | 'legal_entity' | 'everybody' required

Group for which this field is visible

optionsstring[]

Array of options to choose from

Example request

{
  "schema_id": "1",
  "company_id": "1",
  "label": "T-shirt size",
  "field_type": "text",
  "required": true,
  "max_value": 10,
  "position": 2,
  "editable": "team_leader",
  "visible": "everybody",
  "options": [
    "yes",
    "no",
    "maybe"
  ]
}

Response

CREATED

idstring required

Resource field identifier

field_idstring

Custom Field identifier

Example response

{
  "id": "1",
  "field_id": "2"
}

Changes