> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lyzr.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List Agent Shares

> Retrieve a list of all user IDs that have been granted shared access to a specific agent.

Retrieve a complete list of users who currently have shared access to a specific Voice Agent.

If your platform supports collaborative agent building or shared organization access, this endpoint allows you to programmatically verify which `user_ids` are permitted to view, edit, or interact with a given agent configuration.

<Info>
  **Authentication Required:** You must include your API key in the `x-api-key` header to authenticate this request.
</Info>

### Required Parameters

You must provide the agent's ID in the URL path.

* **`agentId`:** The 24-character unique identifier of the agent whose share list you want to retrieve.

### Understanding the Response

A successful `200 OK` response will return a lightweight JSON object containing two fields:

* **`agent_id`:** Confirms the ID of the agent you queried.
* **`user_ids`:** An array of strings representing the internal IDs of users who have been granted access to this agent. If the agent is completely private to its creator, this array may be empty.

### Common Errors

* **`404 Agent not found`:** This typically means the `agentId` provided does not exist within your organization, or it was previously deleted. Double-check the ID string for typos.


## OpenAPI

````yaml get /agents/{agentId}/shares
openapi: 3.0.3
info:
  title: Lyzr Voice LiveKit API
  version: 1.0.0
servers:
  - url: https://voice-livekit.studio.lyzr.ai/v1
security: []
paths:
  /agents/{agentId}/shares:
    get:
      summary: List Agent Shares
      description: >-
        Retrieve a list of all user IDs that have been granted shared access to
        a specific agent.
      parameters:
        - name: agentId
          in: path
          required: true
          description: The unique identifier of the agent.
          schema:
            type: string
            example: f790923795a23467555c0ad6
      responses:
        '200':
          description: Share list retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  agent_id:
                    type: string
                    example: f790923795a23467555c0ad6
                  user_ids:
                    type: array
                    description: An array of user IDs that have access to this agent.
                    items:
                      type: string
                      example: user_789xyz
        '404':
          description: Agent not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Agent not found.
                  details:
                    type: string
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````