List share recipients by share ID

client.ResourceSharing.Recipients.List(ctx, shareID, params) (*V4PagePaginationArray[RecipientListResponse], error)

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

shareID string

Share identifier tag.

maxLength32

params RecipientListParams

AccountID param.Field[string]

Path param: Account identifier.

maxLength32

IncludeResources param.Field[bool]Optional

Query param: Include resources in the response.

Page param.Field[int64]Optional

Query param: Page number. Defaults to 1 when per_page is supplied without page. May be omitted entirely along with per_page to receive a non-paginated response.

minimum1

multipleOf1

PerPage param.Field[int64]Optional

Query param: Number of objects to return per page. Defaults to 20 when page is supplied without per_page. May be omitted entirely along with page to receive a non-paginated response.

maximum100

minimum1

multipleOf1

ReturnsExpand Collapse

type RecipientListResponse struct{…}

ID string

Share Recipient identifier tag.

maxLength32

AccountID string

Account identifier.

maxLength32

AssociationStatus RecipientListResponseAssociationStatus

Share Recipient association status.

One of the following:

const RecipientListResponseAssociationStatusAssociating RecipientListResponseAssociationStatus = "associating"

const RecipientListResponseAssociationStatusAssociated RecipientListResponseAssociationStatus = "associated"

const RecipientListResponseAssociationStatusDisassociating RecipientListResponseAssociationStatus = "disassociating"

const RecipientListResponseAssociationStatusDisassociated RecipientListResponseAssociationStatus = "disassociated"

Created Time

When the share was created.

formatdate-time

Modified Time

When the share was modified.

formatdate-time

Resources []RecipientListResponseResourceOptional

Error string

Share Recipient error message.

ResourceID string

Share Resource identifier.

maxLength32

ResourceVersion int64

Resource Version.

Terminal bool

Whether the error is terminal or will be continually retried.

List share recipients by share ID

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/resource_sharing"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  page, err := client.ResourceSharing.Recipients.List(
    context.TODO(),
    "3fd85f74b32742f1bff64a85009dda07",
    resource_sharing.RecipientListParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "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
  }
}