API REFERENCE

List Agent Sign-Ups (Admin)

On this page

GET/api/admins/agent/signups

Returns API key sign-up records created by AI agents. Agent sign-ups are identified by the agent+ email prefix in the associated account email. Supports period filtering and returns individual API key records with their associated email and creation timestamp, suitable for building sign-up trend charts. Requires admin authentication.

Authentication

x-api-key in header

bearerAuth bearer

Request

cURL

curl --request GET \
  --url 'https://api.recoupable.dev/api/admins/agent/signups' \
  --header 'x-api-key: YOUR_API_KEY'

Replace the YOUR_ placeholders with your values. Required query parameters are included; optional parameters are listed below.

Parameters

Query parameters

periodstring · enum

Time period to filter sign-ups. 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

200Agent sign-up records retrieved successfully

application/json

statusstring · enumrequired

Status of the request

Values: "success"

totalintegerrequired

Total number of agent API key sign-ups matching the period filter

signupsarray<object>required

Array of agent API key sign-up records, ordered by creation date descending

Item properties

idstringrequired

Unique identifier of the API key record

format: uuid

namestringrequired

Name given to the API key

emailstringrequired

The agent+ prefixed email used to create the API key

format: email

created_atstringrequired

Timestamp when the API key was created

format: date-time

401Unauthorized - missing or invalid credentials

application/json

statusstring · enumrequired

Status of the request

Values: "error"

messagestringrequired

Error message describing what went wrong

403Forbidden - authenticated account is not an admin

application/json

statusstring · enumrequired

Status of the request

Values: "error"

messagestringrequired

Error message describing what went wrong

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download accounts.json

View operation source

json

{
  "description": "Returns API key sign-up records created by AI agents. Agent sign-ups are identified by the agent+ email prefix in the associated account email. Supports period filtering and returns individual API key records with their associated email and creation timestamp, suitable for building sign-up trend charts. Requires admin authentication.",
  "parameters": [
    {
      "name": "period",
      "in": "query",
      "description": "Time period to filter sign-ups. 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": "Agent sign-up records retrieved successfully",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "status",
              "total",
              "signups"
            ],
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "success"
                ],
                "description": "Status of the request"
              },
              "total": {
                "type": "integer",
                "description": "Total number of agent API key sign-ups matching the period filter",
                "example": 42
              },
              "signups": {
                "type": "array",
                "description": "Array of agent API key sign-up records, ordered by creation date descending",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "email",
                    "created_at"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid",
                      "description": "Unique identifier of the API key record"
                    },
                    "name": {
                      "type": "string",
                      "description": "Name given to the API key"
                    },
                    "email": {
                      "type": "string",
                      "format": "email",
                      "description": "The agent+ prefixed email used to create the API key"
                    },
                    "created_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp when the API key was created"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized - missing or invalid credentials",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AccountErrorResponse"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden - authenticated account is not an admin",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AccountErrorResponse"
          }
        }
      }
    }
  }
}