Own AWS? Customize your docs with AI search, analytics, and more.

GET

/api/v1/folders/{FolderId}/path

http://workdocs.{region}.amazonaws.com/api/v1/folders/{FolderId}/path

Retrieves the path information (the hierarchy from the root folder) for the specified folder. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.

Access Token Required: API Key

Path Parameters

FolderIdstringrequired

The ID of the folder.

Query Params

limitinteger

The maximum number of levels in the hierarchy to return.

fieldsstring

A comma-separated list of values. Specify "NAME" to include the names of the parent folders.

markerstring

This value is not supported.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://workdocs.{region}.amazonaws.com/api/v1/folders/{FolderId}/path' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/api/v1/folders/{FolderId}/path

http://workdocs.{region}.amazonaws.com/api/v1/folders/{FolderId}/path

Retrieves the path information (the hierarchy from the root folder) for the specified folder. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.

Access Token Required: API Key

Path Parameters

FolderIdstringrequired

The ID of the folder.

Query Params

limitinteger

The maximum number of levels in the hierarchy to return.

fieldsstring

A comma-separated list of values. Specify "NAME" to include the names of the parent folders.

markerstring

This value is not supported.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://workdocs.{region}.amazonaws.com/api/v1/folders/{FolderId}/path' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/api/v1/folders/{FolderId}/path

http://workdocs.{region}.amazonaws.com/api/v1/folders/{FolderId}/path

Retrieves the path information (the hierarchy from the root folder) for the specified folder. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.

Access Token Required: API Key

Path Parameters

FolderIdstringrequired

The ID of the folder.

Query Params

limitinteger

The maximum number of levels in the hierarchy to return.

fieldsstring

A comma-separated list of values. Specify "NAME" to include the names of the parent folders.

markerstring

This value is not supported.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://workdocs.{region}.amazonaws.com/api/v1/folders/{FolderId}/path' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/api/v1/folders/{FolderId}/path

http://workdocs.{region}.amazonaws.com/api/v1/folders/{FolderId}/path

Retrieves the path information (the hierarchy from the root folder) for the specified folder. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.

Access Token Required: API Key

Path Parameters

FolderIdstringrequired

The ID of the folder.

Query Params

limitinteger

The maximum number of levels in the hierarchy to return.

fieldsstring

A comma-separated list of values. Specify "NAME" to include the names of the parent folders.

markerstring

This value is not supported.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://workdocs.{region}.amazonaws.com/api/v1/folders/{FolderId}/path' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}