## List

`client.vals.list(ValListParamsquery, RequestOptionsoptions?): ValListResponse`

**get** `/v2/vals`

Lists all vals including all public vals and your unlisted and private vals

### Parameters

- **query:** `ValListParams`

  - **limit:** `number`

    Maximum items to return in each paginated response

  - **cursor:** `string`

    Cursor to start the pagination from

  - **privacy:** `"public" | "unlisted" | "private"`

    This resource's privacy setting. Unlisted resources do not appear on profile pages or elsewhere, but you can link to them.

    - `"public"`

    - `"unlisted"`

    - `"private"`

  - **user\_id:** `string`

    User ID to filter by

### Returns

- `ValListResponse`
  A paginated result set

  - **data:** `Array<Val>`

    - **id:** `string`

      The id of the val

    - **author:** `Author`

      - **id:** `string`

      - **username:** `string | null`

    - **createdAt:** `string`

    - **description:** `string | null`

    - **imageUrl:** `string | null`

      The URL of this val's image

    - **links:** `Links`

      - **html:** `string`

        The URL of this resource on Val Town

      - **self:** `string`

        The URL of this resource on this API

    - **name:** `string`

    - **privacy:** `"public" | "unlisted" | "private"`

      This resource's privacy setting. Unlisted resources do not appear on profile pages or elsewhere, but you can link to them.

      - `"public"`

      - `"unlisted"`

      - `"private"`

  - **links:** `PaginationLinks`

    Links to use for pagination

### Example

```node
import ValTown from '@valtown/sdk';

const client = new ValTown({
  bearerToken: 'My Bearer Token',
});

const vals = await client.vals.list({ limit: 1 });

console.log(vals.data);
```