{
"profile": {
"id": "<string>",
"version": "2025-01-01T12:34:20Z",
"firstName": "<string>",
"nickname": "<string>",
"description": "<string>",
"birthdate": "1990-05-14",
"countryCode": "FR",
"city": "<string>",
"postalCode": "<string>",
"timeZone": "Europe/Paris",
"features": {
"height": 123,
"weight": 123,
"job": "<string>",
"working": null,
"interests": [],
"bdsmInterests": [],
"sexualInterests": [],
"lookingFor": [],
"childrenCount": 123,
"unitSystem": "METRIC",
"sports": [],
"musicGenres": []
},
"mainPictureUrl": "https://example.org/images/public.jpg",
"pictures": [
"https://example.org/images/public.jpg"
],
"privatePictures": [
"https://example.org/images/private.jpg"
],
"expiresAt": "2025-01-01T12:34:20Z",
"children": [
{
"name": "<string>",
"age": 123
}
],
"pets": [
{
"name": "<string>",
"age": 123,
"breed": "<string>",
"type": "<string>"
}
]
}
}Profile Endpoint
Get a profile by ID.
{
"profile": {
"id": "<string>",
"version": "2025-01-01T12:34:20Z",
"firstName": "<string>",
"nickname": "<string>",
"description": "<string>",
"birthdate": "1990-05-14",
"countryCode": "FR",
"city": "<string>",
"postalCode": "<string>",
"timeZone": "Europe/Paris",
"features": {
"height": 123,
"weight": 123,
"job": "<string>",
"working": null,
"interests": [],
"bdsmInterests": [],
"sexualInterests": [],
"lookingFor": [],
"childrenCount": 123,
"unitSystem": "METRIC",
"sports": [],
"musicGenres": []
},
"mainPictureUrl": "https://example.org/images/public.jpg",
"pictures": [
"https://example.org/images/public.jpg"
],
"privatePictures": [
"https://example.org/images/private.jpg"
],
"expiresAt": "2025-01-01T12:34:20Z",
"children": [
{
"name": "<string>",
"age": 123
}
],
"pets": [
{
"name": "<string>",
"age": 123,
"breed": "<string>",
"type": "<string>"
}
]
}
}⚠️ Important Note: Image Accessibility We do not download or store images on our servers. Therefore, your profile images must be publicly accessible so that our server can retrieve them whenever needed during response generation.
🕒 Important Note: Time Zone Always return thetimeZonefield, especially on the persona profile. The Persona reads the current local time from its own profile’stimeZone. If it is omitted, the Persona falls back to UTC, producing incorrect time-of-day references (e.g. saying it’s 4am when it’s 6am locally). See Supported Time Zones.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is an access key.
Example: Authorization: Bearer sk-proj-XXXXXXXXX
Query Parameters
This parameter will contain the profile ID required to retrieve the associated data. Your endpoint must be able to handle this parameter.
Response
Profile data fetched successfully. Your endpoint will respond with the appropriate JSON data.
Hide child attributes
Hide child attributes
The profile's ID (must be the same as the profileId parameter passed to the endpoint).
Gender of the profile owner.
WOMAN, MAN, TRANS_MAN, TRANSMASCULINE, TRANS_WOMAN, TRANSFEMININE An arbitrary string compared against the one stored in our profile database; any mismatch will trigger a profile data refresh. For example, you can use the latest update date as the version number.
"2025-01-01T12:34:20Z"
First name of the profile owner. You must provide either a first name or a nickname. At least one is required.
Nickname of the profile owner. You must provide either a first name or a nickname. At least one is required.
Description of the profile.
Birthdate of the profile owner, formatted as yyyy-MM-dd.
"1990-05-14"
Country code of the profile owner. Must be a two-letter ISO 3166-1 alpha-2 code.
2"FR"
City of the profile owner. You must provide a country code for this parameter to be used by our system. If no country code is provided, the city will be ignored.
64Postal code of the profile owner. You must provide a country code for this parameter to be used by our system. If no country code is provided, the postal code will be ignored.
64Time zone of the profile owner. See our supported time zones list.
"Europe/Paris"
Features of the profile.
Hide child attributes
Hide child attributes
The ethnicity of the profile. Default is null.
ASIAN, BLACK, CAUCASIAN, MIDDLE_EAST, HISPANIC_LATINO, INDIAN, MEDITERRANEAN, OTHER, UNCERTAIN Height in metric by default (cm). Set unitSystem to IMPERIAL for inches.
Weight in metric by default (kg). Set unitSystem to IMPERIAL for pounds.
The color of the eyes. Default is null.
BLACK, BLUE_GREY, BLUE, BROWN, GREEN_BLUE, GREEN, GREY, OTHER, UNKNOWN The color of the hair. Default is null.
BLACK, BLOND, BROWN, DARK_BLOND, GREY, RED, WHITE, OTHER, UNKNOWN The length of the hair. Default is null.
AVERAGE, BALD, HALF_LONG, LONG, SHORT, VERY_LONG, VERY_SHORT The marital status of the profile. Default is null.
SINGLE, SEPARATED, IN_RELATIONSHIP, MARRIED, DIVORCED, WIDOW The job of the profile. Default is null.
32Explicitly controls whether the profile is currently working. When set, this takes precedence over inferring the working status from the presence of the job attribute. Defaults to null, in which case the working status is determined by whether job is set.
The interests of the profile. Default is an empty array.
TAILORING, BOOK_READING, TRAVELING, COOKING, GARDENING, PHOTOGRAPHY, PAINTING, MUSIC, MOVIES, CYCLING, HIKING, FITNESS, GAMING, DANCING, YOGA, SOFTWARE_DEVELOPMENT, DIY_PROJECTS, WRITING, LANGUAGES, ASTRONOMY, VOLUNTEERING, FISHING, BIRD_WATCHING, SPORTS, EDUCATION, ECONOMY, FOOD_DRINKING, CULINARY, TECHNOLOGY, MEDICAL, NATURE, CULTURE, ART The BDSM interests of the profile. Default is an empty array.
BDSM_BLOOD_PLAY, BDSM_BONDAGE, BDSM_BREATH_PLAY, BDSM_BUTTOCKS, BDSM_DOMINATION, BDSM_EDGE_PLAY, BDSM_FIRE_PLAY, BDSM_FISTING, BDSM_FLOGGING, BDSM_GOLDEN_SHOWER, BDSM_HARD, BDSM_KINKSTER, BDSM_KNIFE_PLAY, BDSM_MASOCHIST, BDSM_NEEDLE_PLAY, BDSM_ORGASM_DENIAL, BDSM_PET_PLAY, BDSM_QUEENING_FACESITTING, BDSM_SADISM, BDSM_SOFT, BDSM_STRAP_ON_DILDO, BDSM_SUBMISSION, BDSM_SUSPENSION, BDSM_ZENTAI The sexual interests of the profile. Default is an empty array.
ANAL, VAGINAL, ORAL_GIVING, ORAL_RECEIVING, KISSING, CUDDLING, DOMINANCE, SUBMISSION, BDSM, ROLEPLAY, PUBLIC_SEX, GROUP_SEX, SWINGING, WATCHING, BEING_WATCHED, THREESOME, FOREPLAY, DIRTY_TALK, SENSUAL_MASSAGE, TOYS, LIGHT_BONDAGE, SPANKING, CHOKING, FEET, EXHIBITIONISM, VOYEURISM The profile looking for genders. Default is an empty array.
MAN, WOMAN The sexual orientation of the profile. Default is null.
HETEROSEXUAL, GAY, LESBIAN, BISEXUAL, ASEXUAL, DEMISEXUAL, PANSEXUAL, QUEER, QUESTIONING, AROMANTIC, OMNISEXUAL, OTHER The number of children the profile has. Default is null.
The preference for having children. Default is null.
YES, NO, MAYBE For Transgender profile only. The surgery status of the profile. Default is null.
UNKNOWN, PRE_OP, POST_OP, NON_OP, PREFER_NOT_TO_SAY The unit system used for the profile. Default is METRIC.
IMPERIAL, METRIC Describes the user's current living situation. Default is null if unspecified.
ALONE, KIDS, PARENTS, ROOMMATE, PARTNER, PARTNER_AND_KIDS The education level of the profile. Default is null.
NO_EDUCATION, PRIMARY_EDUCATION, HIGH_SCHOOL_DIPLOMA, ASSOCIATES_DEGREE, BACHELORS_DEGREE, MASTERS_DEGREE, DOCTORATE The religion of the profile. Default is null.
NO_RELIGION, AGNOSTIC, CHRISTIAN, CATHOLIC, PROTESTANT, MUSLIM, JEWISH, HINDU, BUDDHIST, SPIRITUAL, OTHER The smoking habits of the profile. Default is null.
NEVER, OCCASIONALLY, REGULARLY, TRYING_TO_QUIT, VAPING The body shape of the profile. Default is null.
SLIM, ATHLETIC, AVERAGE, FEW_EXTRA_POUNDS, CURVY, FULL_PLUS_SIZE, MUSCULAR The sports practiced by the profile. Default is an empty array.
SOCCER, BASKETBALL, TENNIS, SWIMMING, RUNNING, CYCLING, GYM_CROSSFIT, YOGA, MARTIAL_ARTS, VOLLEYBALL, GOLF, SKIING_SNOWBOARDING, RUGBY, SURFING The music genres preferred by the profile. Default is an empty array.
POP, ROCK, HIP_HOP_RAP, RNB_SOUL, ELECTRONIC_DANCE, CLASSICAL, JAZZ, COUNTRY, METAL, INDIE_FOLK, LATIN, REGGAE, TECHNO Personality of the profile.
SUPPORTIVE, TEASING, CONFIDENT, GEEKY, POETIC, HIGH_ENERGY, INTELLECTUAL, ROMANTIC, SARCASTIC, POSSESSIVE, NATURAL, APPRECIATIVE, PASSIONATE URL of the main picture. Must be HTTPS
"https://example.org/images/public.jpg"
List of public picture URLs. All URLs must be HTTPS
["https://example.org/images/public.jpg"]
List of private picture URLs. All URLs must be HTTPS
["https://example.org/images/private.jpg"]
An ISO-8601 formatted date. By default, set to one week after profile creation. Purges profile data when reached; fresh data is fetched on next use. Avoid setting durations shorter than 24 hours. Use the version parameter for user profile updates.
"2025-01-01T12:34:20Z"
List of children the profile has.
List of pets the profile has.
Hide child attributes
Hide child attributes
Name of the pet.
1 - 32Sex of the pet.
MALE, FEMALE Age of the pet.
Breed of the pet.
1 - 32Type of the pet.
1 - 32