No results found. Ask us directly:

How to export a list of users via the API?

Last updated: October 30th 2026 · Status: Validated · Article ID: 4004682

💻 Environment/Context

  • API
  • Users

 

In order for you to get the API key, the Settings > Can view api key permission must be enabled on your account.

If you're unable to follow any of the steps below, kindly reach out to your admin or refer to the Account Type Permissions Overview article for more information.

 

 

❓ Issue/Question

  • How can I export a list of all the users on our platform?
  • You want a file with every user's name, email, account type and status

 

👌 Resolution/Answer

  • Get an API key
    • Copy the API key from an account with Users > Can view page and Can view users permissions
  • Call the users endpoint (or paste to your AI ChatBot)
    • Send a GET request to media.scoreplay.io/v1/users?api_key=<API_key>&limit=5000
    • Set limit higher than your number of users, so all users come back in one response
    • Check that the number of users in items matches total
  • Convert the response to a CSV file
    • Each user in items has their ID, name, email, account type, status, company, external group ID and creation date
    • Filter on user_permission_name, external_group_id or status if you only need some of the users

 

🔖 Notes

  • The list includes users with every status, including deactivated users
  • You can find more information on our API documentation portal