Account User Search

get

https://api.aptivada.com/v2/account/{client_id}/user-search

Advanced user search by activity, demographics, etc.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Description

Returns user records that match given filters. Does not paginate. Does not return user attributes. Only returns user records.

Authorization

Either 1) x-token, or 2) x-api-key must be given to authenticate account.

Path Params

client_id

string

required

Account ID

Query Params

first_name

string

If present, filters users by first name

last_name

string

If present, filters users by last name

string

If present, filters users by email

include_child_accounts

boolean

Defaults to false

If true, searches all child accounts with same criteria

account_ids

array of strings

If present, returns users ONLY from specified accounts. (Must be child accounts of authorized account)

account_ids

custom_attributes

array

Key-value pairs of custom attributes. If present, filters users by custom attribute values.

custom_attributes

has_custom_attributes

array of strings

Array of custom attribute slugs. If present, filters users by existence of specified custom attributes. The value of the attribute does not matter.

has_custom_attributes

has_entered

int32

App ID. If present, returns users who entered into specified app. Does not support child account queries.

has_not_entered

int32

App Id. If present, returns users who have not entered specified contest. Does not support child account queries.

birthday_gte

date

If present, returns users who's birthday is greater than specified date.

birthday_lte

date

If present, returns users who have birthday less than specified date.

last_connected

date

If present, returns users who have logged in, or had some type of activity AFTER the date provided.

has_connected

boolean

Defaults to false

If true, returns users who have entered at least one contest.

has_earned

int32

Form field Id. If present, returns users who have responses for that field.

Headers

x-token

string

Admin's auth token

x-api-key

string

Authorized account's API key

Responses

Description

Authorization

200200

400400