API Reference

List users

get
https://api.balampay.com/sandbox/v1/users

Retrieves a paginated list of users for the authenticated client. Supports filtering by status, type, verification status, email, and creation date range.

Authentication: Both x-api-key header and Authorization: Bearer <token> header are required.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 100
Defaults to 10

Maximum number of results to return (1-100)

integer
≥ 0
Defaults to 0

Number of results to skip for pagination

string
enum

Filter by user status

string
enum

Filter by user type

Allowed:
string

Filter by email (substring match)

string
enum

Filter by verification status

Allowed:
date-time

Return users created at or after this ISO 8601 timestamp

date-time

Return users created at or before this ISO 8601 timestamp

Headers
string
required

API key for authentication

Responses

401

Unauthorized - Invalid or missing authentication token

500

Internal Server Error

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?