Skip to main content

I’m trying to fetch all the users in a project, but I’m reading the API’s documentation and there isn’t an endpoint related to fetch all the users in an account. Does anyone know if there is something like that? Or is there a way to create an export or report with the API? Thanks!

Hi Luis,

Thanks so much for reaching out 😊

You can export all users within a single project using the /api/export/data.csv endpoint.
https://api.iterable.com/api/docs#export_exportDataCsv 

Under “dataType Name” select “user”, for range include “all” and under “onlyFields” add the user fields that you would like to export such as “email” or “userId”. 

 

I hope this helps but please let me know if you have any follow-up questions.

 

Best,

Alejandra 


@luismiguells doing this with the API is possible, but it’s much easier to use other tools. CSV export is great if you want to do this one time, or manually, otherwise using a CDP like Segment, Amplitude, RudderStack, etc is best to handle this programatically.


@alejandra.perez thank you so much, it helps me a lot. But I don’t know if there is some kind of documentation of the types of reports we can create. I’m having some problems to extract email and username. I don’t know why in the email field I’m receiving @placeholder.email and encoded email, for the username I have an empty field. 

@drakeballew thank you so much for that information, I’m using the API because I’m trying to create a pipeline with Python to extract this information. I don’t know if for example Segment has some integration to move the data to a S3 bucket for example.

Thanks a lot, both. 


Hi Luis!

Thanks for the update! What range did you use when submitting the API request? Also, do users have a “userId” field in their profile? If this field isn’t set, it could explain why it’s appearing as empty. We can also explore this further in a support ticket, please feel free to submit a ticket to our support team if you’re still experiencing issues with the request 🙂

Best,

Alejandra


Hi ​@alejandra.perez ,

Sorry if I’m late to reply, I reach out to the support team, and the problem was more related with the anonymous users. I was trying to filter those, but support team guide me with another solution. But I think your answer it’s the correct one for this topic for future queries if anyone wants to know how to extract users using the API.

Thanks,

Luis Miguel


Reply