API REFERENCE
List Privy Logins (Admin)
On this page
/api/admins/privyReturns Privy login statistics for a given time period. Results include counts for new accounts (created_at), active accounts (latest_verified_at), total Privy accounts across all time, and the full, unmodified Privy account objects. See Privy User object documentation for the complete type definition. Defaults to period=all (no date filter). Requires the authenticated account to be a Recoup admin. Authentication via x-api-key or Authorization Bearer token.
Authentication
x-api-key in header
bearerAuth bearer
Request
curl --request GET \
--url 'https://api.recoupable.dev/api/admins/privy' \
--header 'x-api-key: YOUR_API_KEY'Replace the YOUR_ placeholders with your values. Required query parameters are included; optional parameters are listed below.
Try it
Fill in the fields, send the request from your browser, and read the live response. The curl below updates as you type.
Kept in this browser tab only and cleared when it closes.
curl --request GET \
--url 'https://recoup-api.vercel.app/api/admins/privy'Parameters
Query parameters
periodstring · enumTime period to filter logins. One of: all (no date filter), daily (last 24 hours), weekly (last 7 days), monthly (last 30 days). Defaults to all.
Values: "all", "daily", "weekly", "monthly"
Default: "all"
Responses
200Privy login statistics retrieved successfully+
application/json
statusstring · enumrequiredStatus of the request
Values: "success"
totalintegerrequiredTotal number of accounts in Privy across all time (not filtered by period)
total_newintegerrequiredNumber of accounts created (created_at) within the requested period
total_activeintegerrequiredTotal number of accounts matching either new or active criteria in the requested period
loginsarray<object>requiredFull, unmodified Privy account objects. See Privy User object docs for the complete type definition.
Item properties for logins
object
401Unauthorized - missing or invalid credentials+
application/json
statusstring · enumrequiredStatus of the request
Values: "error"
messagestringrequiredError message describing what went wrong
403Forbidden - authenticated account is not a Recoup admin+
application/json
statusstring · enumrequiredStatus of the request
Values: "error"
messagestringrequiredError message describing what went wrong
500Internal server error+
application/json
statusstring · enumrequiredStatus of the request
Values: "error"
messagestringrequiredError message describing what went wrong
Full specification
Download the OpenAPI file for complete schemas, constraints, and examples.
Download accounts.jsonView operation source
{
"description": "Returns Privy login statistics for a given time period. Results include counts for new accounts (created_at), active accounts (latest_verified_at), total Privy accounts across all time, and the full, unmodified Privy account objects. See [Privy User object documentation](https://docs.privy.io/api-reference/users/get-all) for the complete type definition. Defaults to period=all (no date filter). Requires the authenticated account to be a Recoup admin. Authentication via x-api-key or Authorization Bearer token.",
"parameters": [
{
"name": "period",
"in": "query",
"description": "Time period to filter logins. One of: all (no date filter), daily (last 24 hours), weekly (last 7 days), monthly (last 30 days). Defaults to all.",
"required": false,
"schema": {
"type": "string",
"enum": [
"all",
"daily",
"weekly",
"monthly"
],
"default": "all"
}
}
],
"security": [
{
"apiKeyAuth": []
},
{
"bearerAuth": []
}
],
"responses": {
"200": {
"description": "Privy login statistics retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"status",
"total",
"total_new",
"total_active",
"logins"
],
"properties": {
"status": {
"type": "string",
"enum": [
"success"
],
"description": "Status of the request"
},
"total": {
"type": "integer",
"description": "Total number of accounts in Privy across all time (not filtered by period)",
"example": 42
},
"total_new": {
"type": "integer",
"description": "Number of accounts created (created_at) within the requested period",
"example": 15
},
"total_active": {
"type": "integer",
"description": "Total number of accounts matching either new or active criteria in the requested period",
"example": 30
},
"logins": {
"type": "array",
"description": "Full, unmodified Privy account objects. See [Privy User object docs](https://docs.privy.io/api-reference/users/get-all) for the complete type definition.",
"items": {
"type": "object"
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized - missing or invalid credentials",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden - authenticated account is not a Recoup admin",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountErrorResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountErrorResponse"
}
}
}
}
}
}