Can you get a users email address from the list users API call?

[l_dellar]

Hi

We've been trying to get the email address field within the list of users API call:

/api/v1/accounts/:account_id/users

The User Objects returned in this list do not include the email address within that object by default, in the documentation it lists email address as optional so is only shown in certain API calls so presumably this doesn't include this API call, so we wondered why that is?

We want to return this field as part of the user objects in the list so that we can check if email addresses need to be updated from our records system, this currently would require us to list users then check each users profile via a separate API call and then update it this seems unnecessary when dealing with multiple 1000's of user records.

Is there anyway we can get the email address to be returned as part of this one call.

Thanks

[MattHanes · Accepted solution]

Try adding

?include[]=email

at the end of the URL.
/api/v1/accounts/1/users?include[]=email

[l_dellar]

Hi Matt

Thanks alot that's perfect, Is there any reason why this isn't documented in the API Documentation?

[MattHanes]

I do not have a good answer for you on that  @l_dellar . Perhaps one of the fantastic Community Managers such as stefaniesanders or  @Renee_Carney  might be able to give us a name that we can tag into this thread to update the API documentation. I've seen this question get asked a few times now. I'm sure documentation on all of the things that we can include[] would be most welcome!

[Stef_retired]

 @MattHanes ‌ and  @l_dellar ‌, we've brought this to the attention of the engineers.

[ag3811]

It is discussed in some places in the live documentation, but it would be nice to have it discussed elsewhere.

[ag3811]

On the other hand, I can't find a way to retrieve the user's non-primary email addresses...

[themidiman]

 @ag3811 ,

Wouldn't this endpoint work for getting all the email addresses someone might have in their user profile?

Communication Channels - Canvas LMS REST API Documentation 

[ag3811]

That did work, Jeffrey, thanks!