---
title: "Worker Profile Image"
method: GET
path: "/workers/{workerId}/profileimage"
tags: ["Worker"]
---

# Worker Profile Image

`GET /workers/{workerId}/profileimage`

## Request

- Base URL: `https://api.paychex.com`
- URL: `https://api.paychex.com/workers/{workerId}/profileimage`
- Auth: none declared
- TypeScript: <https://skmtc.dev/paychex/apis/external-api/docs/workers/:workerId/profileimage/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve profile image for an "Active" or "In-Progress" worker.

## Path parameters

- `workerId` string, required

## Response `200`

Successful operation

- object
  - `content` ProfileImageEntity
    - `fileName` string
    - `base64Image` string
  - `links` Link1[]
    - `href` string
    - `hreflang` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string
    - `templated` boolean

## Other responses

- `400`: Profile image does not exist for the worker provided. (API-7)
- `401`: Unauthorized
- `403`: User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)
- `404`: Invalid resource ID (API-7)
- `405`: Unsupported method type (API-59)
- `406`: Unsupported Accept header
- `500`: Internal Server Error

---

[API](https://skmtc.dev/paychex/apis/external-api.md) - [All operations](https://skmtc.dev/paychex/apis/external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paychex/apis/external-api/revisions/07161d3e073f?raw)
