User Lists (Filter)

Returns a paginated list of users filtered by demographics, pricing, and availability.

Header Parameters
Authorization
required
string
Example: Basic VGhpc0lzWW91ckFQSUtleUtLXBJdFhNZmU=
Authorization header containing your API key.
Request Body Schema: application/json
POST
object
Inclusive follower count range. Users with followers between min and max (inclusive) match.
min
integer
Default: 0
max
integer
Default: 10000
object
Inclusive age range in years. Users with age between min and max (inclusive) match.
min
integer
Default: 0
max
integer
Default: 100
object
Inclusive price range (your currency). Users with price between min and max (inclusive) match.
min
integer
Default: 0
max
integer
Default: 25000
genders
string[]
Allowed gender identities for the user. We’ll match users whose gender is in this list. Allowed values (case-insensitive): Male, Female, Transgender, Gender neutral, Non-binary, I'd rather not say.
style_content
string
Match when the user has not this style tag.
ad_category
string
Match when the user has not this category tag.
time_zone
string
time zone identifier (e.g., Asia/Kolkata). We’ll interpret all slots[].date + slots[].time in this zone, then compare to user availability (converting as needed).
object
Desired time windows when the user is available. Each item has a date and a time range. A user matches if they have any availability overlapping all provided slot window
date
date
time
string
POST
webhook
Request samples
Payload
Content type
application/json

                        

                      

                    


                    

                      
Response samples

                      

                        200
                        application/json
                      

                      

                        

                          
                          

                        

                      

                    


                    

                      401
                      application/json
                    

                    

                      

                        
                        

                      

                    


                  

                

              

            

          

          

            

              

                

                  
Users Information

                  
 Returns profile and pricing metadata for one or more users, looked up by their IDs. 


                  


                  
Header Parameters

                  

                    

                      
Authorization

                      required
                    

                    

                      string
                      

                        Example:
                        Basic VGhpc0lzWW91ckFQSUtleUtLXBJdFhNZmU=
                      

                      
Authorization header containing your API key.

                    

                  

                  

                    

                      
Request Body Schema: application/json

                      POST
                    

                    

                      

                        
user_ids

                        required
                      

                      

                        string[]
                        
Array of unique user IDs to fetch

                      

                    

                    

                      

                        
start_date

                      

                      

                        string
                        
Date range where user need to run advertisement.

                      

                    

                    

                      

                        
end_date

                      

                      

                        string
                        
Date range where user need to run advertisement.

                      

                    

                  

                

              



              

                

                  

                    

                      POST
                      
webhook

                    

                  

                  

                    

                      

                        
Request samples

                        Payload
                      

                      
Content type

                      
application/json

                      

                        

                          
                          

                        

                      

                    


                    

                      
Response samples

                      

                        200
                        application/json
                      

                      

                        

                          
                          

                        

                      


                      

                        401
                        application/json
                      

                      

                        

                          
                          

                        

                      

                    

                  

                

              

            

          

          

            

              

                

                  
Create Advertisement

                  
 Creates one or more advertisements including creative (image/video), associated user IDs, and
                    scheduled time slots. All slot times are interpreted in the given time_zone. The data is stored in
                    your system for future processing or integration.


                  


                  
Header Parameters

                  

                    

                      
Authorization

                      required
                    

                    

                      string
                      

                        Example:
                        Basic VGhpc0lzWW91ckFQSUtleUtLXBJdFhNZmU=
                      

                      
Authorization header containing your API key.

                    

                  



                  

                    

                      
Request Body Schema: application/json

                      POST
                    

                    

                      

                        

                          
                        

                        

                          object[]
                          
One or more commercials to create as a batch. Each item describes a single ad
                            booking.
                          

                        

                      

                      

                        

                          

                            
seconds

                          

                          

                            integer
                            
Duration of the creative, in seconds.

                          

                        

                        

                          

                            
attachment_type

                          

                          

                            string (enum)
                            
Acceptable values: "Image" or "Video"

                          

                        

                        

                          

                            
attachment_url

                          

                          

                            string
                            
Absolute URL to the creative file.

                          

                        

                        

                          

                            
ad_number

                          

                          

                            string
                            
Booking/reference number.

                          

                        

                        

                          

                            
                          

                          

                            object[]
                            
One or more airing/posting windows for this commercial.

                          

                        

                        

                          

                            

                              
date

                            

                            

                              string
                              
Calendar day for the airing window (interpreted in time_zone).

                            

                          

                          

                            

                              
time

                            

                            

                              string
                              
Start and end in 12-hour clock with seconds. Start < End; the span should
                                equal seconds (±1s tolerance if partner allows).
                              

                            

                          

                        

                        

                          

                            
commercial_users

                          

                          

                            string[]
                            
List of user IDs to associate with the commercial.

                          

                        


                      

                      

                      

                        
time_zone

                      

                      

                        string
                        
Time zone used to interpret all commercial_slots[*].date + time ranges.

                      

                    

                    

                  

                

              



              

                

                  

                    

                      POST
                      
webhook

                    

                  

                  

                    

                      

                        
Request samples

                        Payload
                      

                      
Content type

                      
application/json

                      

                        

                          
                          

                        

                      

                    


                    

                      
Response samples

                      

                        200
                        application/json
                      

                      

                        

                          
                          

                        

                      


                      

                        401
                        application/json