---
title: "Find lenses"
method: GET
path: "/lenses"
tags: ["lenses"]
---

# Find lenses

`GET /lenses`

Find a lens or lenses. You may query using field filters with asterisk (*) wildcards. You may also optionally specify sort, limit, offset, and a list of fields to include in the response. The global default limit will apply if no limit param is specified.

## Query parameters

- `fields` string[]
- `sort` string[]
- `limit` integer
- `offset` integer
- `description` string
- `helpEmail` string
- `helpUrl` string
- `lensEventApiVersion` integer
- `isCustom` boolean
- `isPublished` boolean
- `name` string
- `sourceDescription` string
- `sourceName` string
- `sourceVersion` string
- `version` string
- `createdAt` string
- `updatedAt` string

## Response `200`

Success, returns a list of lenses.

- LensesResponse[]
  - `description` string — A description of the lens.
  - `helpEmail` string — The email address where a user can go to get more help about the lens. A lens may choose to display this information to the user e.g. if the user clicks a "help" icon attached to the lens.
  - `helpUrl` string — The url where a user can go to get more help about the lens. A lens may choose to display this information to the user e.g. if the user clicks a "help" icon attached to the lens.
  - `id` string — The lens id.
  - `isCustom` boolean — True for any lens which is installed by an administrator (rather than pre-installed in Refocus).
  - `isPublished` boolean — True when the lens is available to users.
  - `lensEventApiVersion` integer — The API version for the Lens Event API, e.g. 1, 2, etc.
  - `name` string — The name of lens. Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-).
  - `sourceDescription` string — The original lens publisher's description of the lens.
  - `sourceName` string — The original lens publisher's name of the lens.
  - `sourceVersion` string — The original lens publisher's version of the lens.
  - `thumbnailUrl` string — Optional thumbnail image to represent the lens.
  - `installedBy` string — TODO
  - `createdBy` string — Id of the User who created this Lens.
  - `createdAt` string — TODO
  - `updatedAt` string — TODO
  - `apiLinks` HATEOAS[] — Hypertext As The Engine Of Application State.
    - `href` string, required — URL of the related HATEOAS link you can use for subsequent calls.
    - `rel` string, required — Link relation that describes how this link relates to the previous call.
    - `method` string, required — The HTTP method required for the related call.

## Other responses

- `400` — Bad Request
- `401` — Authentication Error
- `default` — Error

## Changes

- **2019-06-07** (v1) `ecfac3832a69` — 1 info
  - added the new optional `query` request parameter `lensEventApiVersion`
- **2019-03-14** (v1) `61c43b67559b` — 2 info
  - added the new optional `query` request parameter `createdAt`
  - added the new optional `query` request parameter `updatedAt`
- **2018-03-30** (v1) `4ca6b20ef8df` — 3 warning
  - deleted the `query` request parameter `createdAt`
  - deleted the `query` request parameter `lensEventApiVersion`
  - deleted the `query` request parameter `updatedAt`

[Change history](https://skmtc.dev/salesforce/apis/refocus-api/changes/lenses/get.md)

---

[API](https://skmtc.dev/salesforce/apis/refocus-api.md) · [All operations](https://skmtc.dev/salesforce/apis/refocus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/salesforce/refocus-api/revisions/42c2153b047e/schema)