> ## 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.

# List Users

> List all users under your partner account

Returns a paginated list of all users created under your partner account.

<ParamField header="Authorization" type="string" required>
  Bearer token. Example: `Bearer sk_staging_your_api_key`
</ParamField>

<ParamField query="skip" type="number" default="0">
  Number of records to skip for pagination.
</ParamField>

<ParamField query="limit" type="number" default="50">
  Maximum number of records to return.
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl "https://services-staging.getplu.com/api/v1/partner/card/users?skip=0&limit=10" \
    -H "Authorization: Bearer sk_staging_your_api_key"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://services-staging.getplu.com/api/v1/partner/card/users?skip=0&limit=10',
    {
      headers: {
        'Authorization': 'Bearer sk_staging_your_api_key',
      },
    }
  );
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "status": "success",
    "message": "success",
    "data": {
      "users": [
        {
          "serviceId": "acme-user-abc123",
          "email": "jane@example.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "status": "approved",
          "program": "custodial",
          "createdAt": "2025-01-15T10:30:00.000Z"
        },
        {
          "serviceId": "acme-user-def456",
          "email": "john@example.com",
          "firstName": "John",
          "lastName": "Smith",
          "status": "pending_kyc",
          "program": "custodial",
          "createdAt": "2025-01-16T14:00:00.000Z"
        }
      ],
      "pagination": {
        "skip": 0,
        "limit": 10,
        "total": 2
      }
    }
  }
  ```
</ResponseExample>

## Response Fields

Each user object contains:

| Field       | Type   | Description                                                |
| ----------- | ------ | ---------------------------------------------------------- |
| `serviceId` | string | The user's service ID                                      |
| `email`     | string | User's email address                                       |
| `firstName` | string | User's first name                                          |
| `lastName`  | string | User's last name                                           |
| `status`    | string | KYC status: `pending`, `pending_kyc`, `approved`, `denied` |
| `program`   | string | Card program: `custodial` or `non_custodial`               |
| `createdAt` | string | ISO 8601 timestamp of user creation                        |

The `pagination` object contains:

| Field   | Type   | Description               |
| ------- | ------ | ------------------------- |
| `skip`  | number | Number of records skipped |
| `limit` | number | Maximum records per page  |
| `total` | number | Total number of users     |