Is it possible to retrieve faculty/staff profile photo?

Typecode LLC

I'm not seeing the profile photo referenced anywhere in the schools API, is there anywhere to get the profile photo from the contact card/user (or some way to do it via another API)?

Brian Gray

@Typecode LLC - The photo file names are another example of data that is available in an Advanced List but not directly through the API. Start with the User Base object, then add the User Photo object. (You may want to also include the User Roles object so that you can filter the list.)

You will get two file names for each user who has a photo - one for a large image and one for a small image.

To get the full URL of the image, you will have to get the school's unique URL for images. (I went to the contact card for a user, pointed at the photo, right-clicked, and chose Save Image Location.) Use the URL path and the file name to get the image you want (large or small) for each user.

Typecode LLC

@Brian Gray thank you, I need to dive in to Lists as I actually don't know what they are but sounds useful!

Bryna Gleich

@Typecode LLC
This might help you get started

Stephen Boyle

@Typecode LLC
There are urls for profile pics in the Users by ID endpoint

…
"prefix": "Mr.",
"suffix": "III",
"profile_pictures": {
"large_filename_url": "//some.cdn.com/pathTo/largeFilename",
"thumb_filename_url": "//some.cdn.com/pathTo/thumbFilename"
}

Brian Gray

@Typecode LLC -

The endpoint that @Stephen Boyle mentioned does have the info you're looking for. The trade-off is that with that endpoint, you can get the info for only one user at a time. If you need only one user's image and you already have the userID, that endpoint is the better way to go. If you need photos for all users in a role, an Advanced List will probably be faster.

Stephen Boyle

@Typecode LLC
@Brian Gray

The user extended endpoints now return the profile photo url, including Users extended by role(s).

"profile_photo": {
"photo_url": "",
"thumbnail_url": ""

},

Brian Gray

@Stephen Boyle - That's good news. Thanks for adding those fields.

bkg