FAfactorialhr
CustomResources > Schema

Creates a Schema

Changed on

Creates a Schema

post/api/2026-10-01/resources/custom_resources/schemas

Request

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

namestring required

Schema name

company_idstring required

Company identifier where this schema belongs

effective_at_idstring

Custom field identifier

hiddenboolean required

Manages visibility of the schema

positioninteger

Schema position within employee profile

usage_group_slugstring

Schema slug

Example request

{
  "name": "Company Offsite",
  "company_id": "2",
  "effective_at_id": "1",
  "position": 1,
  "usage_group_slug": "company_offsite"
}

Response

CREATED

idstring required

Schema identifier

namestring required

Schema name

company_idstring required

Company identifier where this schema belongs

hiddenboolean required

Manages visibility of the schema

positioninteger

Schema position within employee profile

Example response

{
  "id": "1",
  "name": "Company Offsite",
  "company_id": "2",
  "position": 1
}

Changes