> ## Documentation Index > Fetch the complete documentation index at: https://developer.lemlist.com/llms.txt > Use this file to discover all available pages before exploring further. > Lists the mailboxes a user bought through lemlist in your team, with whether their lemlist profile picture has been pushed to each one. # Get Sender Picture Status export const SnippetObjectReference = ({objectName, objectPath = null}) => { const lowerCaseObjectName = objectName.toLowerCase(); if (lowerCaseObjectName === 'lead' || lowerCaseObjectName === 'leads') { return This endpoint uses the {objectName} object. Make sure to also check the {lowerCaseObjectName === 'lead' ? 'Contact' : 'Lead'} object to understand the distinction between the two. ; } return This endpoint uses the {objectName} object. ; }; Omit `userId` to read your own mailboxes. A teammate's `userId` must belong to your team, otherwise the call answers `403` with the code `SENDER_PICTURE_USER_NOT_IN_TEAM`. Only active mailboxes assigned to that user in your team are listed. When `hasPicture` is `false`, the user has no lemlist profile picture: every sync is refused until they upload one in Settings > Account. This endpoint is in closed beta. It answers `403` with the code `BETA_NOT_ENABLED` unless the sender picture beta is enabled for your team. ## OpenAPI ````yaml get /sender-picture/mailboxes openapi: 3.0.0 info: title: lemlist API version: 1.0.0 description: >- Welcome to the lemlist Developer Documentation. lemlist is very customizable and open. You'll find on this page all the API and integration you can do with lemlist. # Rate Limit lemlist's API rate limits requests in order to prevent abuse and overload of our services. Rate limits are applied on all routes and per API key performing the request. The rate limits are **20** requests per **2** seconds. The response provides any information you may need about it: | Header | Description | | --- | --- | | Retry-After | The number of seconds in which you can retry | | X-RateLimit-Limit | The maximum requests in that time | | X-RateLimit-Remaining | The number of remaining requests you can make | | X-RateLimit-Reset | The date when the rate limit will reset | _Example of values for the rate limit headers_ ``` json { "Retry-After": 2, "X-RateLimit-Limit": 20, "X-RateLimit-Remaining": 7, "X-RateLimit-Reset" : "Tue Feb 16 2021 09:02:42 GMT+0100 (Central European Standard Time)" } ``` # Definitions ## Team A team is the entity of lemlist that can handle users and billing. ## Credits Credits are the coins a team uses to enrich emails, LinkedIn URLs, etc. via the enrich route. Each enrichment feature needs a certain amount of credits to run. ## User You use a user account to connect to lemlist and send messages via the connected emails or LinkedIn account. ## Campaign A campaign is the entity to automate outreach. A campaign has multiple sequences composed of steps. ## Lead A lead is a person that you try to contact via a campaign. ## Activity An activity is the history of all the steps. ## Unsubscribe An unsubscribe occurs when a person decides they don't want to receive emails from you anymore. # Authentication All API routes use the dedicated subdomain `api.lemlist.com`. lemlist uses API keys to allow access to the API. You can get your lemlist API key at our [integration page](https://app.lemlist.com/settings/integrations). You need to add the `Authorization` header using the `Basic` authentication type. `login:password` **where the login is always empty and the password is the API key**. ⚠️ **Don't forget to add the semicolon (**`:`**) before your API key in curl command.** > To authorize, use this code: ``` shell curl https://api.lemlist.com/api/team \ --user ":YourApiKey" ``` **Make sure to replace** **`YourApiKey`** **with your API key.** # Give feedback If you want to report a bug, ask for data, or share with us a use case, please fill this [form](https://lemlist.typeform.com/to/mfVlkyGf). It will help us centralize your needs! servers: - url: https://api.lemlist.com/api security: - basicAuth: [] tags: - name: Enrichment Providers description: >- The data providers lemlist can call to find an email or a phone. Internal providers are paid with lemlist credits and always available. External providers run on your own account: connect one by saving its API key, and it becomes available to your waterfalls. `GET /enrichments/providers` is the catalog of provider ids accepted by the waterfall endpoints. - name: Enrichment Waterfalls description: >- Control which data providers lemlist calls when enriching a contact, and in which order. A waterfall is an ordered list of providers for one enrichment `type` (`email` or `phone`). Providers are tried one after the other until one returns a result. Every team has exactly one default waterfall per type (`isDefault: true`). While its `editor` is `lemlist` it follows the lemlist behaviour: providers you connected with your own API key are tried first, then internal providers in a random order. Once a team member edits its provider list, `editor` becomes that user's id and the list is followed as is; resetting it hands it back to `lemlist`. Custom waterfalls (`isDefault: false`) carry `conditions` on the contact being enriched, keyed by contact property; every key present must match. When a contact is enriched, lemlist runs a single waterfall: the custom waterfall of the requested type whose conditions match the contact, or the default waterfall when none does. If several match, the one with the most condition keys wins, then the most recently updated. Only that waterfall runs; when it finds nothing, the enrichment ends without falling back to another one. paths: /sender-picture/mailboxes: get: tags: - Sender picture summary: Get Sender Picture Status description: >- Lists the mailboxes a user bought through lemlist in your team, with whether their lemlist profile picture has been pushed to each one. Only active mailboxes assigned to the user are returned. Omit `userId` to read your own mailboxes; a teammate's `userId` must belong to your team. This endpoint is in closed beta and answers `403` unless the beta is enabled for your team. operationId: getSenderPictureStatus parameters: - name: userId in: query required: false description: >- A teammate whose mailboxes to read. Omit to read the mailboxes of the API key owner. schema: type: string example: usr_Tn8Bv2Mc4Xz6Lq1Pw responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SenderPictureStatusResponse' example: data: userId: usr_Tn8Bv2Mc4Xz6Lq1Pw hasPicture: true mailboxes: - mailboxId: dem_Xq7Lm2Pz9Rt4Vb8Nc email: john@example.com provider: google status: synced syncedAt: '2026-09-28T14:05:00.000Z' lastError: null hasOverride: false - mailboxId: dem_Hw3Jk6Ds1Fy5Gu0Ea email: john@acme.com provider: m365 status: not-synced syncedAt: null lastError: null hasOverride: false counts: total: 2 synced: 1 notSynced: 1 queued: 0 syncing: 0 failed: 0 notSupported: 0 '400': description: Validation error - `userId` is not a valid user id content: application/json: schema: $ref: '#/components/schemas/SenderPictureError' example: error: Invalid sender picture request. code: SENDER_PICTURE_INVALID_INPUT '401': description: Unauthorized - invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/SenderPictureError' example: error: Route unauthorized code: ROUTE_UNAUTHORIZED '403': description: >- The beta is not enabled for your team, or `userId` is not a member of your team content: application/json: schema: $ref: '#/components/schemas/SenderPictureError' examples: betaNotEnabled: value: error: Beta is not enabled code: BETA_NOT_ENABLED userNotInTeam: value: error: This user is not a member of your team. code: SENDER_PICTURE_USER_NOT_IN_TEAM '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/SenderPictureError' example: error: Internal error code: INTERNAL_ERROR components: schemas: SenderPictureStatusResponse: type: object properties: data: type: object properties: userId: type: string description: The user whose mailboxes are listed hasPicture: type: boolean description: >- Whether the user has a lemlist profile picture. When `false`, every sync is refused until they upload one in Settings > Account. mailboxes: type: array items: $ref: '#/components/schemas/SenderPictureMailbox' counts: type: object description: How many mailboxes sit in each status properties: total: type: integer synced: type: integer notSynced: type: integer queued: type: integer syncing: type: integer failed: type: integer notSupported: type: integer SenderPictureError: type: object description: Error envelope returned by the sender picture endpoints. properties: error: type: string description: Human-readable explanation of the failure code: type: string description: Machine-readable error code, stable across releases SenderPictureMailbox: type: object description: The sender picture sync state of one mailbox bought through lemlist. properties: mailboxId: type: string description: >- Unique identifier of the purchased mailbox (`dem_...`). Pass it as `mailboxId` to [Sync Sender Picture](/api-reference/endpoints/sender-picture/sync-sender-picture). email: type: string format: email description: Address of the mailbox provider: type: string nullable: true enum: - google - m365 - null description: >- Where the picture is pushed. `null` when the mailbox cannot take a picture (see `not-supported`). status: type: string enum: - synced - not-synced - queued - syncing - failed - not-supported description: >- `synced`: the current picture is on the mailbox. `not-synced`: never pushed, or the picture changed since. `queued` / `syncing`: a push is in progress. `failed`: the last push failed, `lastError` says why. `not-supported`: not a Google Workspace or Microsoft 365 mailbox bought through lemlist, nothing can be pushed. syncedAt: type: string format: date-time nullable: true description: When the picture was last pushed, `null` if never lastError: type: string nullable: true description: Why the last push failed, `null` otherwise hasOverride: type: boolean description: >- `true` when this mailbox uses its own picture instead of its owner's lemlist profile picture securitySchemes: basicAuth: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.