Sign in

v1

latestOpenAPI 3.1.02026-07-246026.9 KB

Retrieve a User

Retrieve the profile of a user by searching with a single identifier. Each response returns a users array containing all matching profiles across platforms.

Note: Individual use only

This endpoint is intended for retrieving individual user profiles only. Don't use it for bulk data retrieval, as it may interfere with normal data logging in AIQUA.

Use exactly one identifier parameter per request. Identifiers are case-sensitive; use lowercase for email addresses. To retrieve only specific profile fields, specify them using the fields parameter.

get/users/

Query parameters

user_idstring

The user's ID (case-sensitive). Use exactly one identifier parameter per request.

userIdstring

The user's AIQUA user ID (case-sensitive). Use exactly one identifier parameter per request.

emailstring
Example:jane.doe@email.com

The user's email address. Must be lowercase. Use exactly one identifier parameter per request.

phoneNostring
Example:+886912345678

The user's phone number (case-sensitive). Use exactly one identifier parameter per request.

IDFAstring

The user's Identifier for Advertisers (iOS) (case-sensitive). Use exactly one identifier parameter per request.

AAIDstring

The user's Android Advertising ID (case-sensitive). Use exactly one identifier parameter per request.

fieldsstring
Example:user_id,aiq_push_enabled

A comma-separated list of profile fields to include in the response. If omitted, all available fields are returned.

Headers

appidstring required
Example:<YOUR_APP_ID>

Required. Your AIQUA app ID.

authorizationstring required
Example:Token <YOUR_API_TOKEN>

Required. Your AIQUA API token. Must start with "Token".

Response

Success

usersobject[]

An array of matching user profiles. Empty if no users were found.

All 6 operations