v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBGet Employee Photo
Returns an employee photo at the requested size. Available sizes are: original (full resolution), large (340×340), medium (170×170), small (150×150), xs (50×50), and tiny (20×20). The response shape is selected via standard HTTP content negotiation. By default the body is the stored image bytes and the Content-Type response header matches the body (image/jpeg, image/png, image/bmp, image/gif, or image/tiff). When the caller sends Accept: application/json, the body is a JSON object { mimeType, fileBase64 } with the same image bytes base64-encoded. The JSON variant is not recommended for AI connector use, since the base64 payload is too large for an AI model to consume reliably as text input. For AI connectors that need to display or reference a photo, use the photoUrl field returned by list-employees instead. It is a time-limited signed URL that avoids transferring image bytes through the AI model's context.
A 404 response covers three distinct cases: (1) the employee exists but has no photo on file (a normal, non-error state), (2) the employee ID does not exist, or (3) the size value is not one of the recognized options. The x-bamboohr-error-message response header distinguishes them: Employee photo not found, Employee not found, or Size: "<value>" is not a valid size option. Valid sizes are: xs, small, tiny, original, medium and large.. Treat "Employee photo not found" as a normal "no photo on file" result rather than as a bad employee ID, permission failure, or other error to debug.
OAuth Scopes: employee:photo
Path parameters
The ID of the employee whose photo to retrieve.
The desired photo size. One of: original, large, medium, small, xs, tiny.
Query parameters
Optional. Scales the returned image to the specified pixel width, capped at the natural width of the requested size. Only applies to small and tiny sizes.
Optional. Scales the returned image to the specified pixel height, capped at the natural height of the requested size. Only applies to small and tiny sizes.
Response
Employee photo, returned in one of two shapes via standard HTTP content negotiation: binary image/* bytes by default (matching the stored format), or application/json with { mimeType, fileBase64 } when the caller sends Accept: application/json.