Filters are used to refine your search results when working with the user object. This page provides the complete list of supported user filters.
| Fields | Description |
|---|---|
country | Country of residence of this user. Allowed values are ISO 3166-1 alpha-2 country codes. |
exclude_ids | List of user IDs to exclude from the result set. |
flags | List of simple boolean flags available to reduce the result set. |
ids | Limit the result set to this list of user channels identifiers. |
language | Limit the result set to users using this language. Allowed values are **ISO-639-3 alpha-2 and alpha-3 ** language codes. |
limit | Limits the number of results per page. Max: 100 |
mostpopular | Limit the result set to the most popular users. |
page | The page number to load. Allows to navigate from one page to the other when the results are on several pages. Max: 10 if limit=100Depends if has_more at the top of the page is true or false |
parent | Limit the result set to children profiles of this user. |
partner | Limit the result set to premium profiles. |
recommended | Limit the result set to recommended profiles. |
recommendedforchannel | Limit the result set to top profiles within a category. |
sort | Change the default result set ordering. |
usernames | Limit the results set to profiles with a list of usernames. |
verified | Limit the result set to verified partner profiles. |
country
Country of residence of this user. Allowed values are ISO 3166-1 alpha-2 country codes.
Max length: 150
| Type | Sample value |
|---|---|
| string | us |
exclude_ids
List of user IDs to exclude from the result set.
Max length: 150
| Type | Sample value |
|---|---|
| array of strings | xk2k3, x26m1j4, xkeg4 |
flags
List of simple boolean flags available to reduce the result set.
| Type | Sample value |
|---|---|
| array of strings | Possible values: mostpopular recommended partner or verified |
ids
Limit the result set to this list of user channels identifiers.
Max length: 150
| Type | Sample value |
|---|---|
| array of strings | xk2k3, x1fz4ii, xw83x45 |
language
Limit the result set to users using this language. Allowed values are ISO-639-3 alpha-2 and alpha-3 language codes.
Min length: 1 - Max length: 150
| Type | Sample value |
|---|---|
| array of strings | en |
limit
limitLimits the number of results per page.
Max: 100
| Type | Sample value |
|---|---|
| number | 50 |
mostpopular
Limit the result set to the most popular users.
| Type | Sample value |
|---|---|
| flag | N/A |
page
pageThe page number to load. Allows to navigate from one page to the other when the results are on several pages.
Max: 10 if limit=100
Depends if has_more at the top of the page is true or false
| Type | Sample value |
|---|---|
| number | 1 |
parent
Limit the result set to children profiles of this user.
| Type | Sample value |
|---|---|
| object | N/A |
partner
Limit the result set to premium profiles.
| Type | Sample value |
|---|---|
| flag | N/A |
recommended
Limit the result set to recommended profiles.
| Type | Sample value |
|---|---|
| flag | N/A |
recommendedforchannel
Limit the result set to top profiles within a category.
Possible values: animals creation auto school people fun videogames tech kids lifestyle shortfilms music news sport tv travel webcam
| Type | Sample value |
|---|---|
| tring | animals |
sort
Change the default result set ordering.
Possible values: recent relevance popular activity
| Type | Sample value |
|---|---|
| string | popular |
usernames
Limit the results set to profiles with a list of usernames.
Min length: 1 - Max length: 150
| Type | Sample value |
|---|---|
| array of strings | dailymotion,canalplus |
verified
Limit the result set to verified partner profiles.
| Type | Sample value |
|---|---|
| flag | N/A |