List User

GET

/api/third-party/partner/user/

Call this endpoint to retrieve users who signed up to PressOne via your platform. This endpoint is paginated and allows you to filter users by mobile number or email address.

Usage Notes:
You can filter users by providing either mobile or email query parameters
If no filters are provided, all users from your platform will be returned (paginated)
The subscription object provides detailed information about the user's current subscription status
All date fields are returned in ISO 8601 format (date-time)

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://prod.your-api-server.com/api/third-party/partner/user/?mobile=&email=&page_index&page_size' \
--header 'Authorization;'

Response Example

{
  "message": "string | null",
  "success": true,
  "total": 1,
  "page_size": 1,
  "page_index": 1,
  "nb_pages": 1,
  "previous": "string | null",
  "next": "string | null",
  "data": [
    {
      "first_name": "string | null",
      "last_name": "string | null",
      "email": "string | null",
      "mobile": "string | null",
      "subscription": {
        "plan": "string",
        "term": "string",
        "standard_cost": 0,
        "is_active": true,
        "is_free_trial": false,
        "billing_day": "2024-01-15T10:30:00Z",
        "date_created": "2024-01-15T10:30:00Z"
      },
      "date_created": "2024-01-15T10:30:00Z"
    }
  ]
}

Modified at 2025-11-16 11:01:27

Renew Number