Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adapty Profiles API

Get, create, update, and delete end-user profiles.

Adapty Profiles API is one of 6 APIs that Adapty publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Profiles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 1 path, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://api.adapty.io/api/v2/server-side-api.

4 operations 1 paths 7 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.adapty.io/api/v2/server-side-api
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Adapty Profiles API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Secret API key passed as Authorization: Api-Key . Find your secret key in the Adapty dashboard under App Settings API keys.

Paths & Operations 4

Across 1 path, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Profiles 4

Get, create, update, and delete end-user profiles.

GET
/profile/
Get profile
getProfile 2 params → 200
POST
/profile/
Create profile
createProfile body → 200
PATCH
/profile/
Update profile
updateProfile 2 params body → 200
DELETE
/profile/
Delete profile
deleteProfile 2 params → 204

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are AccessLevel (8 properties), Profile (7 properties), Subscription (7 properties), NonSubscription (6 properties). Each schema is shown below with its type and property counts.

Subscription
object
7 properties
CreateProfileRequest
object
3 properties
AccessLevel
object
8 properties
ProfileResponse
object
1 property
UpdateProfileRequest
object
3 properties
Profile
object
7 properties
NonSubscription
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adapty-profiles-api-openapi.yml Raw ↑

Other APIs Adapty publishes across the network.

Adapty Webhooks
Adapty Access Levels API
Adapty Integrations API
Adapty Paywalls API
Adapty Purchases API