Check Share Job Status

POST

https://api.dropboxapi.com/2/sharing/check_share_job_status

POST

/2/sharing/check_share_job_status

import requests
url = "https://api.dropboxapi.com/2/sharing/check_share_job_status"
payload = { "async_job_id": "34g93hh34h04y384084" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

Response headers

HTTP/1.1 200 OK
X-Dropbox-Request-Id: string

{
  ".tag": "complete",
  "access_inheritance": {
    ".tag": "inherit"
  },
  "access_type": {
    ".tag": "owner"
  },
  "folder_id": "id:a4ayc_80_OEAAAAAAAAAXw",
  "is_inside_team_folder": false,
  "is_team_folder": false,
  "link_metadata": {
    "audience_options": [
      {
        ".tag": "public"
      },
      {
        ".tag": "team"
      },
      {
        ".tag": "members"
      }
    ],
    "current_audience": {
      ".tag": "public"
    },
    "link_permissions": [
      {
        "action": {
          ".tag": "change_audience"
        },
        "allow": true
      }
    ],
    "password_protected": false,
    "url": ""
  },
  "name": "dir",
  "owner_display_names": [
    "Jane Doe"
  ],
  "owner_team": {
    "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
    "name": "Acme, Inc."
  },
  "parent_folder_name": "Parent Shared Folder",
  "path_lower": "/dir",
  "permissions": [],
  "policy": {
    "acl_update_policy": {
      ".tag": "owner"
    },
    "member_policy": {
      ".tag": "anyone"
    },
    "resolved_member_policy": {
      ".tag": "team"
    },
    "shared_link_policy": {
      ".tag": "anyone"
    }
  },
  "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf",
  "shared_folder_id": "84528192421",
  "time_invited": "2016-01-20T00:00:00Z"
}

Returns the status of an asynchronous job for sharing a folder.

Required scope: sharing.write

Endpoint format: RPC

Authentication: User, Dropbox-API-Select-Admin (Team Admin)

This endpoint does not support apps with the app folder permission.

Authentication

AuthorizationBearer

OAuth 2.0 token issued to a specific user. Use Authorization: Bearer <token>.

Public clients should use the authorization code flow with PKCE (S256).

For background or offline access, send token_access_type=offline during authorization and use the returned refresh token to obtain new access tokens.

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

Headers

Request

This endpoint expects an object.

async_job_idstringRequired>=1 character

Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Response headers

X-Dropbox-Request-IdstringOptional

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

Response

Successful response

Variant:

sharing_apiv2.ShareFolderJobStatus.in_progressobject

The asynchronous job is still in progress.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error