--- title: Recipients --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Resource Sharing](https://developers.cloudflare.com/api/python/resources/resource_sharing) 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/python/resources/resource_sharing/subresources/recipients/methods/list) resource\_sharing.recipients.list(strshare\_id, RecipientListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[RecipientListResponse]()] GET/accounts/{account\_id}/shares/{share\_id}/recipients ##### [Get share recipient by ID](https://developers.cloudflare.com/api/python/resources/resource_sharing/subresources/recipients/methods/get) resource\_sharing.recipients.get(strrecipient\_id, RecipientGetParams\*\*kwargs) -> [RecipientGetResponse]() GET/accounts/{account\_id}/shares/{share\_id}/recipients/{recipient\_id} ##### [Trigger a recipient addition to a share](https://developers.cloudflare.com/api/python/resources/resource_sharing/subresources/recipients/methods/create) resource\_sharing.recipients.create(strshare\_id, RecipientCreateParams\*\*kwargs) -> [RecipientCreateResponse]() POST/accounts/{account\_id}/shares/{share\_id}/recipients ##### [Trigger a recipient removal from a share](https://developers.cloudflare.com/api/python/resources/resource_sharing/subresources/recipients/methods/delete) resource\_sharing.recipients.delete(strrecipient\_id, RecipientDeleteParams\*\*kwargs) -> [RecipientDeleteResponse]() DELETE/accounts/{account\_id}/shares/{share\_id}/recipients/{recipient\_id} ##### ModelsExpand Collapse
class RecipientListResponse: … 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: str Share Recipient identifier tag. maxLength32 Link to this property account\_id: str Account identifier. maxLength32 Link to this property
association\_status: Literal\["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" Link to this property "associated" Link to this property "disassociating" Link to this property "disassociated" Link to this property
Link to this property created: datetime When the share was created. formatdate-time Link to this property modified: datetime When the share was modified. formatdate-time Link to this property
resources: Optional\[List\[Resource]] error: str Share Recipient error message. Link to this property resource\_id: str Share Resource identifier. maxLength32 Link to this property resource\_version: int Resource Version. Link to this property terminal: bool Whether the error is terminal or will be continually retried. Link to this property
Link to this property
[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_list_response%20%3E%20(schema)>)
class RecipientGetResponse: … 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: str Share Recipient identifier tag. maxLength32 Link to this property account\_id: str Account identifier. maxLength32 Link to this property
association\_status: Literal\["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" Link to this property "associated" Link to this property "disassociating" Link to this property "disassociated" Link to this property
Link to this property created: datetime When the share was created. formatdate-time Link to this property modified: datetime When the share was modified. formatdate-time Link to this property
resources: Optional\[List\[Resource]] error: str Share Recipient error message. Link to this property resource\_id: str Share Resource identifier. maxLength32 Link to this property resource\_version: int Resource Version. Link to this property terminal: bool Whether the error is terminal or will be continually retried. Link to this property
Link to this property
[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_get_response%20%3E%20(schema)>)
class RecipientCreateResponse: … 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: str Share Recipient identifier tag. maxLength32 Link to this property account\_id: str Account identifier. maxLength32 Link to this property
association\_status: Literal\["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" Link to this property "associated" Link to this property "disassociating" Link to this property "disassociated" Link to this property
Link to this property created: datetime When the share was created. formatdate-time Link to this property modified: datetime When the share was modified. formatdate-time Link to this property
resources: Optional\[List\[Resource]] error: str Share Recipient error message. Link to this property resource\_id: str Share Resource identifier. maxLength32 Link to this property resource\_version: int Resource Version. Link to this property terminal: bool Whether the error is terminal or will be continually retried. Link to this property
Link to this property
[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)>)
class RecipientDeleteResponse: … 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: str Share Recipient identifier tag. maxLength32 Link to this property account\_id: str Account identifier. maxLength32 Link to this property
association\_status: Literal\["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" Link to this property "associated" Link to this property "disassociating" Link to this property "disassociated" Link to this property
Link to this property created: datetime When the share was created. formatdate-time Link to this property modified: datetime When the share was modified. formatdate-time Link to this property
resources: Optional\[List\[Resource]] error: str Share Recipient error message. Link to this property resource\_id: str Share Resource identifier. maxLength32 Link to this property resource\_version: int Resource Version. Link to this property terminal: bool Whether the error is terminal or will be continually retried. Link to this property
Link to this property
[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_delete_response%20%3E%20(schema)>)