---
title: Recipients
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[Resource Sharing](https://developers.cloudflare.com/api/typescript/resources/resource%5Fsharing)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Recipients

##### [List share recipients by share ID](https://developers.cloudflare.com/api/typescript/resources/resource%5Fsharing/subresources/recipients/methods/list)

client.resourceSharing.recipients.list(stringshareID, RecipientListParams { account\_id, include\_resources, page, per\_page } params, RequestOptionsoptions?): V4PagePaginationArray<[RecipientListResponse](https://developers.cloudflare.com/api/typescript/resources/resource%5Fsharing#%28resource%29%20resource%5Fsharing.recipients%20%3E%20%28model%29%20recipient%5Flist%5Fresponse%20%3E%20%28schema%29) { id, account\_id, association\_status, 3 more } \>

GET/accounts/{account\_id}/shares/{share\_id}/recipients

##### [Get share recipient by ID](https://developers.cloudflare.com/api/typescript/resources/resource%5Fsharing/subresources/recipients/methods/get)

client.resourceSharing.recipients.get(stringrecipientID, RecipientGetParams { account\_id, share\_id, include\_resources } params, RequestOptionsoptions?): [RecipientGetResponse](https://developers.cloudflare.com/api/typescript/resources/resource%5Fsharing#%28resource%29%20resource%5Fsharing.recipients%20%3E%20%28model%29%20recipient%5Fget%5Fresponse%20%3E%20%28schema%29) { id, account\_id, association\_status, 3 more } 

GET/accounts/{account\_id}/shares/{share\_id}/recipients/{recipient\_id}

##### [Create a new share recipient](https://developers.cloudflare.com/api/typescript/resources/resource%5Fsharing/subresources/recipients/methods/create)

client.resourceSharing.recipients.create(stringshareID, RecipientCreateParams { body\_account\_id, organization\_id, recipient\_account\_id } params, RequestOptionsoptions?): [RecipientCreateResponse](https://developers.cloudflare.com/api/typescript/resources/resource%5Fsharing#%28resource%29%20resource%5Fsharing.recipients%20%3E%20%28model%29%20recipient%5Fcreate%5Fresponse%20%3E%20%28schema%29) { id, account\_id, association\_status, 3 more } 

POST/accounts/{account\_id}/shares/{share\_id}/recipients

##### [Delete a share recipient](https://developers.cloudflare.com/api/typescript/resources/resource%5Fsharing/subresources/recipients/methods/delete)

client.resourceSharing.recipients.delete(stringrecipientID, RecipientDeleteParams { account\_id, share\_id } params, RequestOptionsoptions?): [RecipientDeleteResponse](https://developers.cloudflare.com/api/typescript/resources/resource%5Fsharing#%28resource%29%20resource%5Fsharing.recipients%20%3E%20%28model%29%20recipient%5Fdelete%5Fresponse%20%3E%20%28schema%29) { id, account\_id, association\_status, 3 more } 

DELETE/accounts/{account\_id}/shares/{share\_id}/recipients/{recipient\_id}

##### ModelsExpand Collapse 

RecipientListResponse { id, account\_id, association\_status, 3 more } 

A recipient of a share. The `association_status` field tracks the lifecycle of the shared resources in the recipient account. All recipients are returned by the list endpoint regardless of status; filter client-side if only active recipients are needed.

id: string

Share Recipient identifier tag.

maxLength32

account\_id: string

Account identifier.

maxLength32

association\_status: "associating" | "associated" | "disassociating" | "disassociated"

The current state of the recipient relative to the share. The `desired_association_status` (not exposed in the response) tracks the target state set by the API; the background reconciliation workflow drives `current_association_status` toward it.

* `associating` — The recipient was recently added; the workflow is pushing shared resources into the recipient account.
* `associated` — Shared resources have been successfully applied to the recipient account.
* `disassociating` — The recipient was removed (via DELETE or PUT replacement); the workflow is removing shared resources from the recipient account.
* `disassociated` — Shared resources have been removed from the recipient account. The recipient record remains in the database.

One of the following:

"associating"

"associated"

"disassociating"

"disassociated"

created: string

When the share was created.

formatdate-time

modified: string

When the share was modified.

formatdate-time

resources?: Array<Resource\>

error: string

Share Recipient error message.

resource\_id: string

Share Resource identifier.

maxLength32

resource\_version: number

Resource Version.

terminal: boolean

Whether the error is terminal or will be continually retried.

RecipientGetResponse { id, account\_id, association\_status, 3 more } 

A recipient of a share. The `association_status` field tracks the lifecycle of the shared resources in the recipient account. All recipients are returned by the list endpoint regardless of status; filter client-side if only active recipients are needed.

id: string

Share Recipient identifier tag.

maxLength32

account\_id: string

Account identifier.

maxLength32

association\_status: "associating" | "associated" | "disassociating" | "disassociated"

The current state of the recipient relative to the share. The `desired_association_status` (not exposed in the response) tracks the target state set by the API; the background reconciliation workflow drives `current_association_status` toward it.

* `associating` — The recipient was recently added; the workflow is pushing shared resources into the recipient account.
* `associated` — Shared resources have been successfully applied to the recipient account.
* `disassociating` — The recipient was removed (via DELETE or PUT replacement); the workflow is removing shared resources from the recipient account.
* `disassociated` — Shared resources have been removed from the recipient account. The recipient record remains in the database.

One of the following:

"associating"

"associated"

"disassociating"

"disassociated"

created: string

When the share was created.

formatdate-time

modified: string

When the share was modified.

formatdate-time

resources?: Array<Resource\>

error: string

Share Recipient error message.

resource\_id: string

Share Resource identifier.

maxLength32

resource\_version: number

Resource Version.

terminal: boolean

Whether the error is terminal or will be continually retried.

RecipientCreateResponse { id, account\_id, association\_status, 3 more } 

A recipient of a share. The `association_status` field tracks the lifecycle of the shared resources in the recipient account. All recipients are returned by the list endpoint regardless of status; filter client-side if only active recipients are needed.

id: string

Share Recipient identifier tag.

maxLength32

account\_id: string

Account identifier.

maxLength32

association\_status: "associating" | "associated" | "disassociating" | "disassociated"

The current state of the recipient relative to the share. The `desired_association_status` (not exposed in the response) tracks the target state set by the API; the background reconciliation workflow drives `current_association_status` toward it.

* `associating` — The recipient was recently added; the workflow is pushing shared resources into the recipient account.
* `associated` — Shared resources have been successfully applied to the recipient account.
* `disassociating` — The recipient was removed (via DELETE or PUT replacement); the workflow is removing shared resources from the recipient account.
* `disassociated` — Shared resources have been removed from the recipient account. The recipient record remains in the database.

One of the following:

"associating"

"associated"

"disassociating"

"disassociated"

created: string

When the share was created.

formatdate-time

modified: string

When the share was modified.

formatdate-time

resources?: Array<Resource\>

error: string

Share Recipient error message.

resource\_id: string

Share Resource identifier.

maxLength32

resource\_version: number

Resource Version.

terminal: boolean

Whether the error is terminal or will be continually retried.

RecipientDeleteResponse { id, account\_id, association\_status, 3 more } 

A recipient of a share. The `association_status` field tracks the lifecycle of the shared resources in the recipient account. All recipients are returned by the list endpoint regardless of status; filter client-side if only active recipients are needed.

id: string

Share Recipient identifier tag.

maxLength32

account\_id: string

Account identifier.

maxLength32

association\_status: "associating" | "associated" | "disassociating" | "disassociated"

The current state of the recipient relative to the share. The `desired_association_status` (not exposed in the response) tracks the target state set by the API; the background reconciliation workflow drives `current_association_status` toward it.

* `associating` — The recipient was recently added; the workflow is pushing shared resources into the recipient account.
* `associated` — Shared resources have been successfully applied to the recipient account.
* `disassociating` — The recipient was removed (via DELETE or PUT replacement); the workflow is removing shared resources from the recipient account.
* `disassociated` — Shared resources have been removed from the recipient account. The recipient record remains in the database.

One of the following:

"associating"

"associated"

"disassociating"

"disassociated"

created: string

When the share was created.

formatdate-time

modified: string

When the share was modified.

formatdate-time

resources?: Array<Resource\>

error: string

Share Recipient error message.

resource\_id: string

Share Resource identifier.

maxLength32

resource\_version: number

Resource Version.

terminal: boolean

Whether the error is terminal or will be continually retried.