FAfactorialhr
CustomFields > Field

Reads a single Field

Changed on

Reads a single Field

get/api/2026-10-01/resources/custom_fields/fields/{id}

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/custom_fields/fields/{id}
  • 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

Path parameters

idstring required

Field identifiers

Response

OK

idstring required

Field identifier

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

The type of the field's value

label_textstring required

Field label

positioninteger

Field position within employee profile

requiredboolean

Requirement to fill this field

min_valueinteger

Minimum value in range field type

max_valueinteger

Maximum value in range field type

legal_entity_namestring

Legal entity name where this field belongs

legal_entity_idstring

Legal entity id where this field belongs

slugstring

Custom field slug

Example response

{
  "id": "2",
  "field_type": "text",
  "label_text": "T-Shirt Size",
  "position": 3,
  "required": true,
  "min_value": 10,
  "legal_entity_name": "Factorial Legal",
  "legal_entity_id": "1",
  "slug": "tshirt_size"
}

Changes