FAfactorialhr
Documents > Folder

Creates a Folder

Changed on

Create a folder.

post/api/2026-10-01/resources/documents/folders

Request

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

Request body

company_idstring required

Company ID

namestring required

Folder name

spacestring required

The space of the folder is related to the type of documents that will be stored in it. You should always use "employee_my_documents"

Example request

{
  "company_id": "1",
  "name": "Payslips",
  "space": "employee_my_documents"
}

Response

CREATED

activeboolean required

Whether the folder is active or not

company_idstring

Company ID of the folder

idstring required

Folder ID

namestring required

Folder name

parent_folder_idstring

Id of the parent folder

spacestring required

The space of the folder is related to the place where the folder is displayed.

Example response

{
  "active": true,
  "company_id": "1",
  "id": "10",
  "name": "Payslips",
  "parent_folder_id": "23"
}

Changes