Skip to main content
GET
/
api
/
admins
/
agent
/
signups
cURL
curl --request GET \
  --url https://api.recoupable.com/api/admins/agent/signups \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "total": 42,
  "signups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "jsmith@example.com",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Your Recoup API key. Learn more.

Query Parameters

​
period
enum<string>
default:all

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.

Available options:
all,
daily,
weekly,
monthly

Response

Agent sign-up records retrieved successfully

​
status
enum<string>
required

Status of the request

Available options:
success
​
total
integer
required

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

Example:

42

​
signups
object[]
required

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