Legal Holds List Held Revisions

POST

https://api.dropboxapi.com/2/team/legal_holds/list_held_revisions

POST

/2/team/legal_holds/list_held_revisions

import requests
url = "https://api.dropboxapi.com/2/team/legal_holds/list_held_revisions"
payload = { "id": "pid_dbhid:abcd1234" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "entries": [
    {
      "author_email": "a@a.com",
      "author_member_id": "dbmid:abcd1234abcd1234abcd1234abcd1234a23",
      "author_member_status": {
        ".tag": "active"
      },
      "content_hash": "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234",
      "file_type": "Document",
      "new_filename": "111_222.pdf",
      "original_file_path": "/a.pdf",
      "original_revision_id": "ab2rij4i5ojgfd",
      "server_modified": "2019-08-12T12:08:52Z",
      "size": 3
    }
  ],
  "has_more": false
}

List the file metadata that’s under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.

Permission : Team member file access.

Required scope: team_data.governance.write

Endpoint format: RPC

Authentication: Team

List the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access. **Required scope:** `team_data.governance.write` **Endpoint format:** [RPC](https://docs.dropboxapi.com/dropbox-api/docs/technical-reference/request-response-formats#rpc-endpoints) **Authentication:** [Team](https://docs.dropboxapi.com/dropbox-api/docs/auth-types#team-authentication)

Authentication

AuthorizationBearer

Team-level OAuth 2.0 token issued to a Dropbox Business admin. Use Authorization: Bearer <token>.

Obtain via the authorization code flow with team-scoped permissions.

Grants access to team-wide administrative operations.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

Team-level OAuth 2.0 token issued to a Dropbox Business admin. Use `Authorization: Bearer <token>`. Obtain via the authorization code flow with team-scoped permissions. Grants access to team-wide administrative operations. You can generate a short-lived access token from the App Console; see [Testing with a generated token](https://docs.dropboxapi.com/dropbox-api/docs/oauth#testing-with-a-generated-token).

Request

This endpoint expects an object.

idstringRequiredformat: "^pid_dbhid:.+"

The legal hold Id.

Response headers

X-Dropbox-Request-IdstringOptional

A unique identifier for the request, useful for debugging and support.

Response

Successful response

entrieslist of objects

List of file entries that under the hold.

has_moreboolean

True if there are more file entries that haven’t been returned. You can retrieve them with a call to /legal_holds/list_held_revisions_continue.

cursorstring or nullOptional>=1 character

The cursor idicates where to continue reading file metadata entries for the next API call. When there are no more entries, the cursor will return none.

Pass the cursor into /2/team/legal_holds/list_held_revisions/continue.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error