CustomFields > Option

Reads all Options

Changed on

Reads all Options

get/api/2026-10-01/resources/custom_fields/options

Request

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

Query parameters

ids[]string[]

Options identifiers

[
  "1",
  "2"
]
field_ids[]string[]

Identifiers for the fields where the options belong to

[
  "3",
  "4"
]

Response

OK

Example response

{
  "data": [
    {
      "id": "1",
      "label": "T-shirt size",
      "value": "L",
      "is_active": true,
      "field_id": "2"
    }
  ]
}

Changes