Folders

List folders

List folders.

get/workspaces/{workspace_id}/projects/{project_id}/folders

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/workspaces/{workspace_id}/projects/{project_id}/folders
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

workspace_idinteger required

Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

Example:4
project_idinteger required

Project ID of the workspace

Example:4

Query parameters

fieldsstring nullable

Fields to be returned in a comma-separated format may include id, name, status_info, created_at.

Example:id,name
idstring

Filter by multiple folder ids, comma separated

Example:1,2,3
namestring nullable

Filter by multiple folder names, comma separated

Example:folder_name1,folder_name2,folder_name3
statusstring nullable

Filter by multiple folder statuses, comma separated

Example:ready,deleting
created_atstring nullable

Filter by multiple folders, which falls under created_at date range

Example:(from:'2023-12-19T09:39:17.728Z',to:'2023-12-26T19:42:43.152Z')
updated_atstring nullable

Filter by multiple folders, which falls under updated_at date range

Example:(from:'2024-12-19T09:39:17.628Z',to:'2024-12-26T09:42:43.152Z')
created_bystring nullable

Filter by multiple folder created by user names, comma separated

Example:riya,geeta
limitinteger

Max number of result to return

Example:10
offsetinteger

Distance from the beginning of the list of results

Example:10
sortstring nullable

Sort the folders based on the fields

Example:(id:asc),(name:asc)

Response

List folders

offsetinteger
limitinteger
nextstring required

URI for next page of data

Example response

{
  "folders": [
    {
      "resource_path": "/workspace:Mammoth Analytics:3/project:test_project:10/label:Folder1:1"
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.