> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stardex.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List sending mailboxes

> Mailboxes a team member can send campaign emails from: their own and those shared with them, with each one's status, daily limit and emails sent today. API keys must pass `sender_team_member_id`; signed-in users get their own. Needs `campaigns:read`.



## OpenAPI

````yaml /api-reference/openapi-v1.json get /v1/campaigns/mailboxes
openapi: 3.1.0
info:
  title: Stardex API (v1)
  version: 1.0.0
  description: >-
    Stardex ATS API — manage candidates, jobs, companies, and recruiting
    workflows.
servers:
  - url: https://api.stardex.ai
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Persons
    description: Manage person records — contacts, work history, and custom fields.
  - name: Jobs
    description: Manage job postings — pipeline stages, team members, and custom fields.
  - name: Candidates
    description: Manage candidate records and pipeline stage transitions.
  - name: Companies
    description: Browse and retrieve company records.
  - name: Lists
    description: Create, search, and retrieve saved person and company lists.
  - name: Person Activities
    description: Create and manage activity records (notes, emails, meetings) for persons.
  - name: Team Members
    description: List team members for use in search filters and assignments.
  - name: Custom Fields
    description: Retrieve custom field definitions and tag options for search filters.
  - name: Campaigns
    description: >-
      Create and edit email campaigns, enroll people through enrollment batches,
      and manage who is enrolled.
paths:
  /v1/campaigns/mailboxes:
    get:
      tags:
        - Campaigns
      summary: List sending mailboxes
      description: >-
        Mailboxes a team member can send campaign emails from: their own and
        those shared with them, with each one's status, daily limit and emails
        sent today. API keys must pass `sender_team_member_id`; signed-in users
        get their own. Needs `campaigns:read`.
      operationId: listCampaignMailboxes
      parameters:
        - schema:
            type: string
            format: uuid
            description: >-
              Whose mailboxes to list. Required with an API key. Signed-in users
              can only list their own, so it can be left out.
          required: false
          description: >-
            Whose mailboxes to list. Required with an API key. Signed-in users
            can only list their own, so it can be left out.
          name: sender_team_member_id
          in: query
      responses:
        '200':
          description: Mailboxes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignMailboxesResponse'
              example:
                success: true
                data:
                  - email: riya@acmetalent.com
                    owner_name: Riya Kapoor
                    is_shared: false
                    status: ready
                    daily_limit: 250
                    sent_today: 38
                    sending_timezone: Europe/London
                    available_at: null
                  - email: outreach@acmetalent.com
                    owner_name: Sam Lee
                    is_shared: true
                    status: daily_limit_reached
                    daily_limit: 250
                    sent_today: 250
                    sending_timezone: America/New_York
                    available_at: '2026-10-14T04:00:00.000Z'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                      details:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Extra facts about the error when they help you fix it,
                          such as a limit and when it resets.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '403':
          description: No access to campaigns, or the API key lacks the permission
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                      details:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Extra facts about the error when they help you fix it,
                          such as a limit and when it resets.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                      details:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Extra facts about the error when they help you fix it,
                          such as a limit and when it resets.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                      details:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Extra facts about the error when they help you fix it,
                          such as a limit and when it resets.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
components:
  schemas:
    CampaignMailboxesResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: array
          items:
            type: object
            properties:
              email:
                type: string
              owner_name:
                type:
                  - string
                  - 'null'
              is_shared:
                type: boolean
                description: Shared with this team member by a teammate.
              status:
                type: string
                enum:
                  - ready
                  - disconnected
                  - rate_limited
                  - daily_limit_reached
                  - sending_disabled
              daily_limit:
                type: integer
                description: Campaign emails it can send per day.
              sent_today:
                type: integer
              sending_timezone:
                type: string
                description: Timezone the daily limit and sent_today count days in.
              available_at:
                type:
                  - string
                  - 'null'
                description: >-
                  When it can send again, if it is paused by the daily limit or
                  rate limiting.
            required:
              - email
              - owner_name
              - is_shared
              - status
              - daily_limit
              - sent_today
              - sending_timezone
              - available_at
      required:
        - success
        - data
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with a Bearer token: API key, OAuth token, or session
        token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.