We’ve migrated our documentation to a new site, which means some URLs have changed.
Subscriptions

How to get the Piano API call for a Mine Users search?

Under Users > Mine Users you’re able to filter your user database based on various criteria. Often you’d like to automate this process and would need to apply the same filters to a publisher/user/search API call.

To make things as easy as possible, on the right-hand side of the screen after you’re executed your Mine Users search, you’ll be able to see and copy the API query which was used to return your results.

bf88acb5-ce6f-4af0-834f-e8ae743ced9b.png

For example, the API request will look like this:

https://api.piano.io/api/v3/publisher/user/search?source=VX&limit=10&credit_card_will_expire={"fromMM":null,"fromYY":null,"untilMM":null,"untilYY":null}&offset=0&custom_fields=[]&esdebug=false&order_direction=asc&has_access=true&consent_checked=false&aid=XYZ&order_by=name

If you would like to apply this API call now, you only need to add the aid and api_token parameters to make it work outside of the Piano dashboard.

Last updated: