List virtual keys | Alephant API Documentation

curl -G https:https://localhost:8080/api/v1/virtual-keys \
     -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampletoken123" \
     -H "X-Workspace-Id: d290f1ee-6c54-4b01-90e6-d701748f0851" \
     -H "Content-Type: application/json" \
     -d page=1 \
     -d pageSize=20 \
     -d status=active \
     -d entityType=agent

{
  "data": [
    {
      "id": "vk_01F8MECHZX3TBDSZ7XRADM79XE",
      "name": "Front Door Key",
      "status": "active",
      "entityType": "agent",
      "assignedTo": "agent_12345",
      "createdAt": "2024-05-10T09:30:00Z",
      "lastUsedAt": "2024-06-01T14:45:00Z"
    },
    {
      "id": "vk_01F8MECHZX3TBDSZ7XRADM79XF",
      "name": "Server Room Access",
      "status": "inactive",
      "entityType": "department",
      "assignedTo": "dept_it",
      "createdAt": "2023-12-15T11:00:00Z",
      "lastUsedAt": "2024-01-20T08:15:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "totalItems": 2,
    "totalPages": 1
  }
}

List user’s virtual keys with optional filters (status, entityType). Owner, admin, viewer.

Query parameters

pageintegerOptionalDefaults to 1

Page number

pageSizeintegerOptionalDefaults to 20

Items per page

statusstringOptional

active, inactive

entityTypestringOptional

agent, member, department

Response

data: list, meta: pagination

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

Headers

Query parameters

Response

Errors