GET api/folders?name={name}

Retrieves a list of workboxes accessible to the authenticated user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

Optional name of the workbox to filter by. If provided, only workboxes with an exact name match are returned.

string

Default value is

Body Parameters

None.

Response Information

Resource Description

On success: HTTP 200 OK with a list of accessible workboxes. On failure: HTTP 400 Bad Request with a generic error message.

Collection of SDFolder
NameDescriptionTypeAdditional 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-21T03:20:00.0959665+00:00",
      "groups": [
        {
          "name": "sample string 1",
          "id": 2
        },
        {
          "name": "sample string 1",
          "id": 2
        }
      ]
    },
    "status": "sample string 5"
  },
  {
    "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-21T03:20:00.0959665+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-21T03:20:00.0959665+00:00",
      "groups": [
        {
          "name": "sample string 1",
          "id": 2
        },
        {
          "name": "sample string 1",
          "id": 2
        }
      ]
    },
    "status": "sample string 5"
  },
  {
    "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-21T03:20:00.0959665+00:00",
      "groups": [
        {
          "name": "sample string 1",
          "id": 2
        },
        {
          "name": "sample string 1",
          "id": 2
        }
      ]
    },
    "status": "sample string 5"
  }
]