/api/v2/server-side-api/profile/ Get profile
Retrieves the details of an existing end user of your app.
Header parameters
The unique ID of the customer in your system. Either adapty-customer-user-id or adapty-profile-id is required.
The unique ID of the profile in your system. Your best option if you are working with anonymous profiles. Either adapty-customer-user-id or adapty-profile-id is required.
Responses
Profile retrieved successfully
Schema
The internal ID of your app
Adapty profile ID
The ID of your user in your system
A float value representing the total revenue in USD earned in the profile
Internal parameter
Response time in milliseconds, needs for resolve a race condition
A maximum of 30 custom attributes to the profile are allowed to be set
The key must be a string with no more than 30 characters. Only letters, numbers, dashes, points, and underscores allowed
The attribute value must be no more than 50 characters. Only strings and floats are allowed as values
Array of Access level objects. Empty array if the customer has no access levels
Access level identifier
Store where the access level was purchased
Product ID in the store
Base plan ID in the store
Transaction ID in the store
Original transaction ID in the store
Offer details, if a promotional or introductory offer was applied
Offer category
One of: "introductory", "promotional", "offer_code", "win_back"
Offer type
One of: "free_trial", "pay_as_you_go", "pay_up_front"
Offer ID
When the access level starts
When the access level was purchased
When the access level was originally purchased
When the access level expires
When renewal was cancelled
When billing issue was detected
Whether the access level is in grace period
Reason for cancellation
Array of Subscription objects. Empty array if the customer has no subscriptions
Store where the subscription was purchased
Product ID in the store
Base plan ID in the store
Transaction ID in the store
Original transaction ID in the store
Offer details, if a promotional or introductory offer was applied
Offer category
One of: "introductory", "promotional", "offer_code", "win_back"
Offer type
One of: "free_trial", "pay_as_you_go", "pay_up_front"
Offer ID
Environment (Sandbox, Production)
When the subscription was purchased
When the subscription was originally purchased
When the subscription expires
When renewal was cancelled
When billing issue was detected
Whether the subscription is in grace period
Reason for cancellation
Array of Non-Subscription objects. Empty array if the customer has no purchases
Unique purchase identifier
Store where the purchase was made
Product ID in the store
Base plan ID in the store
Transaction ID in the store
Original transaction ID in the store
When the purchase was made
Environment (Sandbox, Production)
Whether this is a refund
Whether this is a consumable purchase
Example
{
"data": {
"app_id": "14c3d333-2f3a-455a-aa86-ef83dff6913b",
"profile_id": "d8533a10-bcce-4e33-8c9d-88b05ac56559",
"customer_user_id": "77B14FB4-FD2A-4D38-AA3A-4C433F79863C",
"total_revenue_usd": 9.99,
"segment_hash": "fdaeef7f8aaa33c9",
"timestamp": 1733324566777,
"custom_attributes": [
{
"key": "favourite_sport",
"value": "yoga"
}
],
"access_levels": [
{
"access_level_id": "premium",
"store": "app_store",
"store_product_id": "unlimited.9999",
"store_base_plan_id": null,
"store_transaction_id": "2000000335013007",
"store_original_transaction_id": "2000000335013007",
"offer": null,
"starts_at": null,
"purchased_at": "2024-12-24T10:50:23+00:00",
"originally_purchased_at": "2024-12-24T10:50:23+00:00",
"expires_at": null,
"renewal_cancelled_at": "2025-01-05T13:27:47.461425+00:00",
"billing_issue_detected_at": null,
"is_in_grace_period": false,
"cancellation_reason": null
}
],
"subscriptions": [
{
"store": "app_store",
"store_product_id": "unlimited.9999",
"store_base_plan_id": null,
"store_transaction_id": "2000000815013007",
"store_original_transaction_id": "2000000815013007",
"offer": null,
"environment": "Sandbox",
"purchased_at": "2024-12-24T10:50:23+00:00",
"originally_purchased_at": "2024-12-24T10:50:23+00:00",
"expires_at": null,
"renewal_cancelled_at": null,
"billing_issue_detected_at": null,
"is_in_grace_period": false,
"cancellation_reason": null
}
],
"non_subscriptions": [
{
"purchase_id": "7a5f9a7d-e236-33e6-96d8-53a3c59c5562",
"store": "app_store",
"store_product_id": "1year.premium",
"store_base_plan_id": null,
"store_transaction_id": "30002109551456",
"store_original_transaction_id": "30002109551456",
"purchased_at": "2022-10-12T09:42:50+00:00",
"environment": "Production",
"is_refund": false,
"is_consumable": false
}
]
}
}Unauthorized
Schema
Source of the error
Array of error messages
Short error name
HTTP status code
Example
{
"errors": [
{
"source": "non_field_errors",
"errors": [
"Authentication credentials were not provided."
]
}
],
"error_code": "not_authenticated",
"status_code": 401
}Profile not found
Schema
Source of the error
Array of error messages
Short error name
HTTP status code
Example
{
"errors": [
{
"source": null,
"errors": [
"Profile not found"
]
}
],
"error_code": "profile_does_not_exist",
"status_code": 404
}Internal server error