Skip to main content
GET
/
v1
/
partner
/
card
/
users
curl "https://services-staging.getplu.com/api/v1/partner/card/users?skip=0&limit=10" \
  -H "Authorization: Bearer sk_staging_your_api_key"
{
  "status": "success",
  "message": "success",
  "data": {
    "users": [
      {
        "serviceId": "acme-user-abc123",
        "email": "[email protected]",
        "firstName": "Jane",
        "lastName": "Doe",
        "status": "approved",
        "program": "custodial",
        "createdAt": "2025-01-15T10:30:00.000Z"
      },
      {
        "serviceId": "acme-user-def456",
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Smith",
        "status": "pending_kyc",
        "program": "custodial",
        "createdAt": "2025-01-16T14:00:00.000Z"
      }
    ],
    "pagination": {
      "skip": 0,
      "limit": 10,
      "total": 2
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getplu.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns a paginated list of all users created under your partner account.
Authorization
string
required
Bearer token. Example: Bearer sk_staging_your_api_key
skip
number
default:"0"
Number of records to skip for pagination.
limit
number
default:"50"
Maximum number of records to return.
curl "https://services-staging.getplu.com/api/v1/partner/card/users?skip=0&limit=10" \
  -H "Authorization: Bearer sk_staging_your_api_key"
{
  "status": "success",
  "message": "success",
  "data": {
    "users": [
      {
        "serviceId": "acme-user-abc123",
        "email": "[email protected]",
        "firstName": "Jane",
        "lastName": "Doe",
        "status": "approved",
        "program": "custodial",
        "createdAt": "2025-01-15T10:30:00.000Z"
      },
      {
        "serviceId": "acme-user-def456",
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Smith",
        "status": "pending_kyc",
        "program": "custodial",
        "createdAt": "2025-01-16T14:00:00.000Z"
      }
    ],
    "pagination": {
      "skip": 0,
      "limit": 10,
      "total": 2
    }
  }
}

Response Fields

Each user object contains:
FieldTypeDescription
serviceIdstringThe user’s service ID
emailstringUser’s email address
firstNamestringUser’s first name
lastNamestringUser’s last name
statusstringKYC status: pending, pending_kyc, approved, denied
programstringCard program: custodial or non_custodial
createdAtstringISO 8601 timestamp of user creation
The pagination object contains:
FieldTypeDescription
skipnumberNumber of records skipped
limitnumberMaximum records per page
totalnumberTotal number of users