GET api/folders/{id}

Retrieves metadata for a specific folder or workbox by its internal node ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The internal node ID of the folder or workbox to retrieve. Must correspond to a valid, non-deleted item of type `Folder` or `Workbox`.	integer	Required

Body Parameters

None.

Response Information

Resource Description

On success: HTTP 200 OK with a structured `SDFolder` object. On failure: HTTP 403 Forbidden if access is denied, or 400 Bad Request on error.

SDFolder

Name	Description	Type	Additional information
i_node	Unique database id of the item	integer	None.
f_node	Unique database id of the item's parent, this is needed sometimes to figure out the structure of the content	integer	None.
item	Name\Title of the item	string	None.
description	Description of the item	string	None.
creator	User details who created the item	ViewUserDTO	None.
status	Current status of the item	string	None.

Response Formats

application/json, text/json

Sample:

{
  "i_node": 1,
  "f_node": 2,
  "item": "sample string 3",
  "description": "sample string 4",
  "creator": {
    "userID": 1,
    "userName": "sample string 2",
    "firstName": "sample string 3",
    "lastName": "sample string 4",
    "email": "sample string 5",
    "customFields": [
      {
        "values": [
          "sample string 1",
          "sample string 2"
        ],
        "guid": "sample string 1",
        "type": "sample string 2",
        "dataType": "sample string 3"
      },
      {
        "values": [
          "sample string 1",
          "sample string 2"
        ],
        "guid": "sample string 1",
        "type": "sample string 2",
        "dataType": "sample string 3"
      }
    ],
    "status": "sample string 6",
    "createDate": "2025-11-20T19:44:27.5380189+00:00",
    "groups": [
      {
        "name": "sample string 1",
        "id": 2
      },
      {
        "name": "sample string 1",
        "id": 2
      }
    ]
  },
  "status": "sample string 5"
}

application/scim+json

Sample:

{
  "i_node": 1,
  "f_node": 2,
  "item": "sample string 3",
  "description": "sample string 4",
  "creator": {
    "userID": 1,
    "userName": "sample string 2",
    "firstName": "sample string 3",
    "lastName": "sample string 4",
    "email": "sample string 5",
    "customFields": [
      {
        "values": [
          "sample string 1",
          "sample string 2"
        ],
        "guid": "sample string 1",
        "label": null,
        "type": "sample string 2",
        "dataType": "sample string 3"
      },
      {
        "values": [
          "sample string 1",
          "sample string 2"
        ],
        "guid": "sample string 1",
        "label": null,
        "type": "sample string 2",
        "dataType": "sample string 3"
      }
    ],
    "status": "sample string 6",
    "createDate": "2025-11-20T19:44:27.5380189+00:00",
    "groups": [
      {
        "name": "sample string 1",
        "id": 2
      },
      {
        "name": "sample string 1",
        "id": 2
      }
    ]
  },
  "status": "sample string 5"
}