## List account shares

`client.resourceSharing.list(ResourceSharingListParamsparams, RequestOptionsoptions?): V4PagePaginationArray<ResourceSharingListResponse>`

**get** `/accounts/{account_id}/shares`

Lists all account shares.

### Parameters

- `params: ResourceSharingListParams`

  - `account_id: string`

    Path param: Account identifier.

  - `direction?: "asc" | "desc"`

    Query param: Direction to sort objects.

    - `"asc"`

    - `"desc"`

  - `include_recipient_counts?: boolean`

    Query param: Include recipient counts in the response.

  - `include_resources?: boolean`

    Query param: Include resources in the response.

  - `kind?: "sent" | "received"`

    Query param: Filter shares by kind.

    - `"sent"`

    - `"received"`

  - `order?: "name" | "created"`

    Query param: Order shares by values in the given field.

    - `"name"`

    - `"created"`

  - `page?: number`

    Query param: Page number.

  - `per_page?: number`

    Query param: Number of objects to return per page.

  - `resource_types?: Array<"custom-ruleset" | "gateway-policy" | "gateway-destination-ip" | 2 more>`

    Query param: Filter share resources by resource_types.

    - `"custom-ruleset"`

    - `"gateway-policy"`

    - `"gateway-destination-ip"`

    - `"gateway-block-page-settings"`

    - `"gateway-extended-email-matching"`

  - `status?: "active" | "deleting" | "deleted"`

    Query param: Filter shares by status.

    - `"active"`

    - `"deleting"`

    - `"deleted"`

  - `target_type?: "account" | "organization"`

    Query param: Filter shares by target_type.

    - `"account"`

    - `"organization"`

### Returns

- `ResourceSharingListResponse`

  - `id: string`

    Share identifier tag.

  - `account_id: string`

    Account identifier.

  - `account_name: string`

    The display name of an account.

  - `created: string`

    When the share was created.

  - `modified: string`

    When the share was modified.

  - `name: string`

    The name of the share.

  - `organization_id: string`

    Organization identifier.

  - `status: "active" | "deleting" | "deleted"`

    - `"active"`

    - `"deleting"`

    - `"deleted"`

  - `target_type: "account" | "organization"`

    - `"account"`

    - `"organization"`

  - `associated_recipient_count?: number`

    The number of recipients in the 'associated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

  - `associating_recipient_count?: number`

    The number of recipients in the 'associating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

  - `disassociated_recipient_count?: number`

    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

  - `disassociating_recipient_count?: number`

    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

  - `kind?: "sent" | "received"`

    - `"sent"`

    - `"received"`

  - `resources?: Array<Resource>`

    A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.

    - `id: string`

      Share Resource identifier.

    - `created: string`

      When the share was created.

    - `meta: unknown`

      Resource Metadata.

    - `modified: string`

      When the share was modified.

    - `resource_account_id: string`

      Account identifier.

    - `resource_id: string`

      Share Resource identifier.

    - `resource_type: "custom-ruleset" | "gateway-policy" | "gateway-destination-ip" | 2 more`

      Resource Type.

      - `"custom-ruleset"`

      - `"gateway-policy"`

      - `"gateway-destination-ip"`

      - `"gateway-block-page-settings"`

      - `"gateway-extended-email-matching"`

    - `resource_version: number`

      Resource Version.

    - `status: "active" | "deleting" | "deleted"`

      Resource Status.

      - `"active"`

      - `"deleting"`

      - `"deleted"`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const resourceSharingListResponse of client.resourceSharing.list({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(resourceSharingListResponse.id);
}
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "3fd85f74b32742f1bff64a85009dda07",
      "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
      "account_name": "Account A",
      "created": "2023-09-21T18:56:32.624632Z",
      "modified": "2023-09-21T18:56:32.624632Z",
      "name": "My Shared WAF Managed Rule",
      "organization_id": "023e105f4ecef8ad9ca31a8372d0c353",
      "status": "active",
      "target_type": "account",
      "associated_recipient_count": 10,
      "associating_recipient_count": 1,
      "disassociated_recipient_count": 0,
      "disassociating_recipient_count": 0,
      "kind": "sent",
      "resources": [
        {
          "id": "023e105f4ecef8ad9ca31a8372d0c353",
          "created": "2023-09-21T18:56:32.624632Z",
          "meta": {},
          "modified": "2023-09-21T18:56:32.624632Z",
          "resource_account_id": "023e105f4ecef8ad9ca31a8372d0c353",
          "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
          "resource_type": "custom-ruleset",
          "resource_version": 0,
          "status": "active"
        }
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 50
  }
}
```