Skip to main content
GET
/
{projectApiKey}
/
customers
Get customers list
curl --request GET \
  --url https://api.qonversion.io/v1/analytics/{projectApiKey}/customers
{
  "data": [
    {
      "id": "QON_abc123def456",
      "identity_id": "user_42",
      "created": 1699000000,
      "last_seen": 1701000000,
      "environment": 1,
      "platform": "iOS",
      "country": "US",
      "total_revenue": 49.99,
      "subscription_status": "active",
      "active_entitlements": [
        "premium",
        "pro_features"
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1542,
    "total_pages": 78
  }
}

Path Parameters

​
projectApiKey
string
required

Project API Key for authentication and project identification

Pattern: ^proj_[a-zA-Z0-9]+$
Example:

"proj_abc123xyz456"

Query Parameters

​
page
integer
default:1

Page number for pagination (starts at 1)

Required range: x >= 1
​
limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
​
sort
enum<string>
default:created

Sort field

Available options:
created,
last_seen,
total_revenue
​
order
enum<string>
default:desc

Sort order

Available options:
asc,
desc
​
environment
enum<integer>
default:1

Environment type (0=Sandbox, 1=Production)

Available options:
0,
1
​
filter[target_platform][]
enum<string>[]

Filter by platforms

Available options:
iOS,
Android,
Stripe
​
filter[country][]
string[]

Filter by countries (ISO 3166-1 alpha-2)

Pattern: ^[A-Z]{2}$
​
filter[product_id][]
string[]

Filter by product IDs

​
filter[q_user_id]
string

Filter by Qonversion user ID

​
filter[user_id]
string

Filter by custom user ID

​
filter[device_id]
string

Filter by device ID

​
filter[media_source_name][]
string[]

Filter by media source names

​
filter[campaign_name][]
string[]

Filter by campaign names

​
filter[ad_set_name][]
string[]

Filter by ad set names

​
filter[ad_name][]
string[]

Filter by ad names

​
filter[app_version][]
string[]

Filter by app versions

​
filter[sdk_version][]
string[]

Filter by SDK versions

​
filter[os_version][]
string[]

Filter by OS versions

​
filter[locale][]
string[]

Filter by locales

​
filter[model][]
string[]

Filter by device models

​
filter[purchase_currency][]
string[]

Filter by purchase currencies (ISO 4217)

Pattern: ^[A-Z]{3}$
​
filter[experiment_uid][]
string[]

Filter by experiment UIDs

​
filter[experiment_group_uid][]
string[]

Filter by experiment group UIDs

​
filter[subscription_status][]
enum<string>[]

Filter by subscription status

Available options:
active,
trial,
grace_period,
cancelled,
expired,
never_subscribed
​
filter[entitlement_id][]
string[]

Filter by entitlement IDs

​
filter[created_from]
integer<int64>

Filter customers created after this Unix timestamp

​
filter[created_to]
integer<int64>

Filter customers created before this Unix timestamp

Response

Successful response with paginated customer list

​
data
object[]
required

Array of customer objects

​
pagination
object
required