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

# Get vaultshares



## OpenAPI

````yaml /openapi.json get /vault/shares
openapi: 3.1.1
info:
  title: Anima API
  version: 0.1.0
  description: >-
    The Anima API provides programmatic access to unified infrastructure for AI
    agents: create and manage agents; send and receive email; place phone calls
    and send/receive SMS and voice; store and retrieve vault credentials; manage
    agent identity; and configure webhooks for real-time events. Authenticate
    using a Bearer token or an API key passed via the X-API-Key header.
  contact:
    name: Anima Labs
    url: https://useanima.sh
    email: support@useanima.sh
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.useanima.sh/v1
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: Agents
    description: Create and manage AI agents with email and phone capabilities
  - name: Inboxes
    description: Manage email inboxes and their configurations
  - name: Messages
    description: Send, receive, and search email messages
  - name: Webhooks
    description: Register and manage webhook subscriptions for real-time events
  - name: Organizations
    description: Manage organizations and team settings
  - name: Domains
    description: Configure and verify custom email domains
  - name: Phone
    description: Manage phone numbers and SMS/voice capabilities
  - name: Invoices
    description: Track invoices, match receipts, and reconcile payments
  - name: Billing
    description: View usage, tiers, and billing information
  - name: Security
    description: Configure security policies and access controls
  - name: Vault
    description: Store and retrieve encrypted secrets
  - name: API Keys
    description: Create and manage API keys for programmatic access
paths:
  /vault/shares:
    get:
      operationId: vault.listShares
      parameters:
        - name: agentId
          in: query
          schema:
            anyOf:
              - type: string
                pattern: ^[0-9a-z]+$
              - type: string
                pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
            description: >-
              Agent identifier. Optional when using an agent API key (resolved
              automatically); required when using a master key.
          allowEmptyValue: true
          allowReserved: true
        - name: direction
          in: query
          schema:
            default: received
            enum:
              - granted
              - received
            type: string
            description: Filter by share direction
          allowEmptyValue: true
          allowReserved: true
        - name: cursor
          in: query
          schema:
            type: string
            description: Cursor for pagination
          allowEmptyValue: true
          allowReserved: true
        - name: limit
          in: query
          schema:
            default: 20
            type: integer
            minimum: 1
            maximum: 100
            description: Maximum entries to return
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique share record identifier
                        credentialId:
                          type: string
                          description: Shared credential identifier
                        orgId:
                          type: string
                          description: Organization identifier
                        sourceAgentId:
                          type: string
                          description: Agent that owns the credential
                        targetAgentId:
                          type: string
                          description: Agent that received access
                        permission:
                          enum:
                            - READ
                            - USE
                            - MANAGE
                          type: string
                          description: Permission level
                        expiresAt:
                          anyOf:
                            - type: string
                              format: date-time
                            - type: 'null'
                          description: When the share expires
                        grantedBy:
                          type: string
                          description: Who created the share
                        revokedAt:
                          anyOf:
                            - type: string
                              format: date-time
                            - type: 'null'
                          description: When the share was revoked, if applicable
                        createdAt:
                          type: string
                          format: date-time
                          description: Timestamp when the share was created
                        updatedAt:
                          type: string
                          format: date-time
                          description: Timestamp when the share was last updated
                      required:
                        - id
                        - credentialId
                        - orgId
                        - sourceAgentId
                        - targetAgentId
                        - permission
                        - expiresAt
                        - grantedBy
                        - revokedAt
                        - createdAt
                        - updatedAt
                      description: Credential share record details
                    description: List of credential shares
                  pagination:
                    type: object
                    properties:
                      nextCursor:
                        anyOf:
                          - type: string
                            pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
                          - type: 'null'
                        description: >-
                          Cursor to pass as the `cursor` parameter to retrieve
                          the next page, or null if no more results
                      hasMore:
                        type: boolean
                        description: Whether additional pages of results are available
                    required:
                      - nextCursor
                      - hasMore
                    description: Cursor-based pagination metadata
                required:
                  - items
                  - pagination
                description: Paginated list of credential shares
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token obtained from authentication. Pass as: Authorization:
        Bearer <token>
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for programmatic access. Pass as: X-API-Key: <your-key>'

````