Skip to main content
GET
Requires version 1.1.5 or later of the Archetype platform.

Overview

This endpoint returns detailed information about each lens available to your organization, including lens IDs, names, and configurations.

Request

string
Optional. Filter the response to a specific lens by ID.
integer
default:"-1"
Optional. Shard index for pagination. Use -1 to retrieve all lenses.
integer
default:"-1"
Optional. Maximum items per shard. Use -1 for no limit.

Response

Returns an array of lens objects, each containing:
string
Unique identifier for the lens
string
Human-readable name of the lens
string
Current status of the lens (e.g., “LENS_STATUS_MOUNTED”)
boolean
Whether the lens can be modified or deleted
object
Configuration object containing lens-specific settings and parameters