The three APIs Pick the API that matches who is calling. All three answer JSON, share one error format and the same headers , and never return vault contents in plaintext.
API Base URL Credential Rate limit Endpoints Customer API https://passkey-x.com/apiPersonal API key (pxu_…) or session token 120 requests per minute per key (or per account for a session) 21 Organization API https://passkey-x.com/api/orgOrganization API key (pxk_…) 300 requests per minute per key 73 Agent API https://passkey-x.com/api/agentAgent token (pxa1.<id>.<secret>) One request per second per agent 1
password or private_key are rejected with 422 plaintext_rejected.
First call Describe your key: who it belongs to, its scopes, and the address the API sees (for IP allowlists).
GET /v1/me curl -sS -X GET 'https://passkey-x.com/api/org/v1/me' \
-H "Authorization: Bearer $PASSKEY_X_API_KEY"Customer API Apps and scripts acting as a signed-in person: vault items (ciphertext only), sync, workspaces and access requests.
Base URL https://passkey-x.com/api
Auth Personal API key (pxu_…) or session token
Rate limit 120 requests per minute per key (or per account for a session) System Method Path What it does Needs Reference GET /v1/healthCheck the API is up NoneDetails GET /v1/item-typesList item types Any key Details
Account and API keys Method Path What it does Needs Reference GET /v1/meNew in 1.7 Who am I Any key Details GET /v1/api-keysNew in 1.7 List your personal API keys Any key Details POST /v1/api-keysNew in 1.7 Create a personal API key Session only Details PATCH /v1/api-keys/{key_id}New in 1.7 Change a key's IP allowlist Session only Details DELETE /v1/api-keys/{key_id}New in 1.7 Revoke a personal API key Any key Details GET /v1/api-keys/{key_id}/activityNew in 1.7 A key's recent calls and addresses Any key Details
Workspaces Method Path What it does Needs Reference GET /v1/workspacesList your workspaces workspaces:readDetails GET /v1/workspaces/{workspace_id}/membersList workspace members workspaces:readDetails
Vault items Method Path What it does Needs Reference GET /v1/vault-itemsList vault items vault:readDetails GET /v1/vault-items/{item_id}Get one item vault:readDetails POST /v1/vault-itemsCreate an encrypted item vault:writeDetails PATCH /v1/vault-items/{item_id}Add a new revision vault:writeDetails DELETE /v1/vault-items/{item_id}Delete an item vault:writeDetails
Sync Method Path What it does Needs Reference GET /v1/sync/changesRead the change feed sync:readDetails
Access requests and grants Method Path What it does Needs Reference GET /v1/missionsList missions access:readDetails GET /v1/access-requestsList access requests access:readDetails POST /v1/access-requestsRequest access access:writeDetails POST /v1/access-requests/{request_id}/decisionApprove or deny a request access:writeDetails GET /v1/access-grantsList access grants access:readDetails
Organization API HR, ITSM, SIEM and GRC tools: audit, logs, alerts, members, onboarding, handover, sharing approvals, policies, storage, documents, signatures, webhooks, the security center, the Controller and Remote.
Base URL https://passkey-x.com/api/org
Auth Organization API key (pxk_…)
Rate limit 300 requests per minute per key Key and audit Method Path What it does Scope Reference GET /v1/meDescribe this key —Details GET /v1/audit-eventsRead audit events audit:readDetails GET /v1/items/{item_id}/timelineNew in 1.2 Who used a password audit:readDetails
Logs Method Path What it does Scope Reference GET /v1/logsNew in 1.5 Read logs logs:readDetails
Alerts, reports and policies Method Path What it does Scope Reference GET /v1/alertsList security alerts alerts:readDetails PATCH /v1/alerts/{alert_id}Update an alert alerts:writeDetails GET /v1/security/summarySecurity summary reports:readDetails GET /v1/reports/weeklyWeekly reports reports:readDetails GET /v1/policiesNew in 1.2 List security policies policies:readDetails PUT /v1/policies/{policy_type}New in 1.5 Set and enforce a policy policies:writeDetails DELETE /v1/policies/{policy_type}New in 1.5 Stop enforcing a policy policies:writeDetails
Storage, insights and documents Method Path What it does Scope Reference GET /v1/storageNew in 1.3 Storage report storage:readDetails GET /v1/insightsNew in 1.3 Insights and Trust Index insights:readDetails GET /v1/documentsNew in 1.3 Document register documents:readDetails GET /v1/documents/{document_id}New in 1.3 One document documents:readDetails POST /v1/documents/verifyNew in 1.3 Verify a document documents:readDetails GET /v1/company-group/reportNew in 1.3 Company group report reports:readDetails
Security center Method Path What it does Scope Reference GET /v1/securityNew in 1.4 Security summary security:readDetails GET /v1/incidentsNew in 1.4 Incidents security:readDetails GET /v1/device-trustNew in 1.4 Device trust security:readDetails
Company profile and devices Method Path What it does Scope Reference GET /v1/companyNew in 1.5 Company profile company:readDetails GET /v1/company/devicesNew in 1.5 Company devices and codes company:readDetails POST /v1/company/device-codesNew in 1.5 Issue a device code devices:writeDetails DELETE /v1/company/devices/{device_id}New in 1.5 Remove a company device devices:writeDetails DELETE /v1/company/device-codes/{code_id}New in 1.5 Cancel a device code devices:writeDetails
Members and onboarding Method Path What it does Scope Reference POST /v1/members/{identity_id}/blockNew in 1.5 Block a member members:writeDetails POST /v1/members/{identity_id}/unblockNew in 1.5 Unblock a member members:writeDetails GET /v1/membersList members members:readDetails POST /v1/membersInvite a member members:writeDetails POST /v1/members/{identity_id}/suspendSuspend a member members:writeDetails POST /v1/members/{identity_id}/reactivateReactivate a member members:writeDetails DELETE /v1/members/{identity_id}Offboard a member members:writeDetails GET /v1/invitationsList open invitations members:readDetails DELETE /v1/invitations/{invitation_id}Cancel an invitation members:writeDetails GET /v1/onboardingNew in 1.2 Onboarding progress onboarding:readDetails POST /v1/onboarding/{plan_id}/remindNew in 1.2 Send a reminder onboarding:writeDetails POST /v1/onboarding/{plan_id}/extendNew in 1.2 Extend the deadline onboarding:writeDetails POST /v1/onboarding/{plan_id}/resumeNew in 1.2 Resume paused onboarding onboarding:writeDetails POST /v1/onboarding/{plan_id}/cancelNew in 1.2 Cancel onboarding onboarding:writeDetails GET /v1/member-securityNew in 1.2 Member security for audits reports:readDetails
Access handover Method Path What it does Scope Reference GET /v1/handoversNew in 1.2 List handovers handover:readDetails GET /v1/handovers/previewNew in 1.2 Preview a handover handover:readDetails POST /v1/handoversNew in 1.2 Hand over access handover:writeDetails
Vaults, sharing and access Method Path What it does Scope Reference GET /v1/workspacesList shared vaults workspaces:readDetails GET /v1/groupsList directory groups groups:readDetails GET /v1/access-requestsList vault access requests access:readDetails POST /v1/access-requests/{request_id}/approveApprove a vault request access:writeDetails POST /v1/access-requests/{request_id}/denyDeny a vault request access:writeDetails GET /v1/external-sharesNew in 1.2 External sharing requests sharing:readDetails POST /v1/external-shares/{link_id}/approveNew in 1.2 Approve an external link sharing:writeDetails POST /v1/external-shares/{link_id}/denyNew in 1.2 Decline an external link sharing:writeDetails
Signatures Method Path What it does Scope Reference GET /v1/signature-requestsNew in 1.6 List signature requests documents:readDetails POST /v1/documents/{document_id}/cancelNew in 1.6 Cancel a signature request signatures:writeDetails
Webhooks Method Path What it does Scope Reference GET /v1/webhooks/eventsNew in 1.6 Event catalog webhooks:readDetails GET /v1/webhooksNew in 1.6 List webhooks webhooks:readDetails POST /v1/webhooksNew in 1.6 Create a webhook webhooks:writeDetails GET /v1/webhooks/{webhook_id}New in 1.6 One webhook webhooks:readDetails PATCH /v1/webhooks/{webhook_id}New in 1.6 Change a webhook webhooks:writeDetails DELETE /v1/webhooks/{webhook_id}New in 1.6 Delete a webhook webhooks:writeDetails POST /v1/webhooks/{webhook_id}/rotate-secretNew in 1.6 Rotate the signing secret webhooks:writeDetails POST /v1/webhooks/{webhook_id}/testNew in 1.6 Send a test webhooks:writeDetails GET /v1/webhooks/{webhook_id}/deliveriesNew in 1.6 Delivery log webhooks:readDetails GET /v1/webhooks/{webhook_id}/dead-lettersNew in 1.8 Dead letters webhooks:readDetails POST /v1/webhooks/{webhook_id}/dead-letters/{dead_letter_id}/replayNew in 1.8 Send a dead letter again webhooks:writeDetails POST /v1/webhooks/{webhook_id}/replayNew in 1.6 Replay events webhooks:writeDetails
Controller Method Path What it does Scope Reference GET /v1/controllerNew in 1.7 Computers, groups and recent actions controller:readDetails POST /v1/controller/jobsNew in 1.7 Run an action on computers controller:writeDetails GET /v1/controller/jobs/{job_id}New in 1.7 One action and its results controller:readDetails
Remote Method Path What it does Scope Reference GET /v1/remoteNew in 1.7 Seats, devices and sessions remote:readDetails POST /v1/remote/sessions/{session_id}/endNew in 1.7 End a session remote:writeDetails GET /v1/remote/invitesNew in 1.7 List invite links remote:readDetails POST /v1/remote/invitesNew in 1.7 Create an invite link remote:writeDetails DELETE /v1/remote/invites/{invite_id}New in 1.7 Revoke an invite link remote:writeDetails
Agent API CI pipelines and automation: vaults shared with an agent, decrypted on the agent’s own machine.
Base URL https://passkey-x.com/api/agent
Auth Agent token (pxa1.<id>.<secret>)
Rate limit One request per second per agent Vaults Method Path What it does Needs Reference GET /v1/vaultsRead shared vaults Agent token Details
Need help building on Passkey-X? Questions about the API, a bug or a missing endpoint? Our team replies by email, usually within one business day.
