BTCPay Server Users API
User operations
BTCPay Server Users API is one of 31 APIs that BTCPay Server publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, authentication docs, and rate-limit docs.
This API exposes 11 operations across 6 paths, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version v1.
Requests are made against a single base URL, https://{btcpay-host}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
BTCPay Server Users API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (API_Key).
It accepts HTTP basic authentication (Basic).
By default, every request must be authenticated.
API_Key— BTCPay Server API key. Format: 'token {apiKey}'Basic— HTTP Basic Authentication with email and password
Paths & Operations 11
Across 6 paths, the API surfaces 11 operations — 3 DELETE, 3 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
User operations
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ApplicationUserData (13 properties), ApproveUserRequest (1 property), LockUserRequest (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from BTCPay Server 12
Other APIs BTCPay Server publishes across the network.
This is an independent, third-party profile of BTCPay Server Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.