GET

/api/v1/resources

http://workdocs.{region}.amazonaws.com/api/v1/resources

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

Access Token Required: API Key

Query Params

userIdstring

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

collectionTypestring

The collection type.

Allowed:

limitinteger

The maximum number of resources to return.

markerstring

The marker for the next set of results. This marker was received from a previous call.

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/resources' \
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