Skip to main content
GET
/
vault
/
shares
cURL
curl --request GET \
  --url https://api.useanima.sh/v1/vault/shares \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "credentialId": "<string>",
      "orgId": "<string>",
      "sourceAgentId": "<string>",
      "targetAgentId": "<string>",
      "expiresAt": "2023-11-07T05:31:56Z",
      "grantedBy": "<string>",
      "revokedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Query Parameters

​
agentId

Agent identifier. Optional when using an agent API key (resolved automatically); required when using a master key.

Pattern: ^[0-9a-z]+$
​
direction
enum<string>
default:received

Filter by share direction

Available options:
granted,
received
​
cursor
string

Cursor for pagination

​
limit
integer
default:20

Maximum entries to return

Required range: 1 <= x <= 100

Response

200 - application/json

OK

Paginated list of credential shares

​
items
object[]
required

List of credential shares

​
pagination
object
required

Cursor-based pagination metadata