---
title: "GET /api/v1/resources"
method: GET
path: "/api/v1/resources"
---

# GET /api/v1/resources

`GET /api/v1/resources`

Retrieves a collection of resources, including folders and documents. The only <code>CollectionType</code> supported is <code>SHARED_WITH_ME</code>.

## Query parameters

- `userId` string
- `collectionType` 'SHARED_WITH_ME'
- `limit` integer
- `marker` string

## Headers

- `Authentication` string, password

## Response `200`

Success

- GetResourcesResponse
  - `Folders` FolderMetadata[] — The folders in the specified folder.
    - `Id` string — The ID of the folder.
    - `Name` string, password — The name of the folder.
    - `CreatorId` string — The ID of the creator.
    - `ParentFolderId` string — The ID of the parent folder.
    - `CreatedTimestamp` string, date-time — The time when the folder was created.
    - `ModifiedTimestamp` string, date-time — The time when the folder was updated.
    - `ResourceState` 'ACTIVE' | 'RESTORING' | 'RECYCLING' | 'RECYCLED' — The resource state of the folder.
    - `Signature` string — The unique identifier created from the subfolders and documents of the folder.
    - `Labels` SharedLabel[] — List of labels on the folder.
    - `Size` integer — The size of the folder metadata.
    - `LatestVersionSize` integer — The size of the latest version of the folder metadata.
  - `Documents` DocumentMetadata[] — The documents in the specified collection.
    - `Id` string — The ID of the document.
    - `CreatorId` string — The ID of the creator.
    - `ParentFolderId` string — The ID of the parent folder.
    - `CreatedTimestamp` string, date-time — The time when the document was created.
    - `ModifiedTimestamp` string, date-time — The time when the document was updated.
    - `LatestVersionMetadata` object — The latest version of the document.
      - `Id` string — The ID of the version.
      - `Name` string, password — The name of the version.
      - `ContentType` string — The content type of the document.
      - `Size` integer — The size of the document, in bytes.
      - `Signature` string — The signature of the document.
      - `Status` 'INITIALIZED' | 'ACTIVE' — The status of the document.
      - `CreatedTimestamp` string, date-time — The timestamp when the document was first uploaded.
      - `ModifiedTimestamp` string, date-time — The timestamp when the document was last uploaded.
      - `ContentCreatedTimestamp` string, date-time — The timestamp when the content of the document was originally created.
      - `ContentModifiedTimestamp` string, date-time — The timestamp when the content of the document was modified.
      - `CreatorId` string — The ID of the creator.
      - `Thumbnail` object — The thumbnail of the document.
      - `Source` object — The source of the document.
    - `ResourceState` 'ACTIVE' | 'RESTORING' | 'RECYCLING' | 'RECYCLED' — The resource state.
    - `Labels` SharedLabel[] — List of labels on the document.
  - `Marker` string — The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

## Other responses

- `480` — UnauthorizedResourceAccessException
- `481` — UnauthorizedOperationException
- `482` — InvalidArgumentException
- `483` — FailedDependencyException
- `484` — ServiceUnavailableException

---

[API](https://skmtc.net/aws/apis/workdocs.md) · [All operations](https://skmtc.net/aws/apis/workdocs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/workdocs/versions/8a533af4e1ef/schema)