Skip to content
Cloudflare API
Start here
API Reference
Resource Sharing
Recipients

List share recipients by share ID

resource_sharing.recipients.list(strshare_id, RecipientListParams**kwargs) -> SyncV4PagePaginationArray[RecipientListResponse]
GET/accounts/{account_id}/shares/{share_id}/recipients

List share recipients by share ID.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
ParametersExpand Collapse
account_id: str

Account identifier.

maxLength32
share_id: str

Share identifier tag.

maxLength32
include_resources: Optional[bool]

Include resources in the response.

page: Optional[int]

Page number.

minimum0
multipleOf1
per_page: Optional[int]

Number of objects to return per page.

maximum100
minimum0
multipleOf1
ReturnsExpand Collapse
class RecipientListResponse: …
id: str

Share Recipient identifier tag.

maxLength32
account_id: str

Account identifier.

maxLength32
association_status: Literal["associating", "associated", "disassociating", "disassociated"]

Share Recipient association status.

One of the following:
"associating"
"associated"
"disassociating"
"disassociated"
created: datetime

When the share was created.

formatdate-time
modified: datetime

When the share was modified.

formatdate-time
resources: Optional[List[Resource]]
error: str

Share Recipient error message.

resource_id: str

Share Resource identifier.

maxLength32
resource_version: int

Resource Version.

terminal: bool

Whether the error is terminal or will be continually retried.

List share recipients by share ID

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
page = client.resource_sharing.recipients.list(
    share_id="3fd85f74b32742f1bff64a85009dda07",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.id)
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "3fd85f74b32742f1bff64a85009dda07",
      "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
      "association_status": "associating",
      "created": "2023-09-21T18:56:32.624632Z",
      "modified": "2023-09-21T18:56:32.624632Z",
      "resources": [
        {
          "error": "Recipient is missing necessary entitlement",
          "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
          "resource_version": 0,
          "terminal": true
        }
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 50
  }
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "3fd85f74b32742f1bff64a85009dda07",
      "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
      "association_status": "associating",
      "created": "2023-09-21T18:56:32.624632Z",
      "modified": "2023-09-21T18:56:32.624632Z",
      "resources": [
        {
          "error": "Recipient is missing necessary entitlement",
          "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
          "resource_version": 0,
          "terminal": true
        }
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 50
  }
}