# List all email accounts in the workspace

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /webhook/partner-list-email-accounts:
    get:
      summary: List all email accounts in the workspace
      deprecated: false
      description: >-
        List all email accounts in the workspace. Can be filtered by tags or
        single email.
      tags:
        - For Email Infra Provider Partner
      parameters:
        - name: pipl_username
          in: query
          description: Username of Plusvibe account
          required: false
          schema:
            type: string
        - name: pipl_password
          in: query
          description: Password of Plusvibe account
          required: false
          schema:
            type: string
        - name: workspace_id
          in: query
          description: Workspace ID
          required: true
          schema:
            type: string
            description: Workspace ID
            default: ''
            examples:
              - 65f3c92d3dbe5dbb35374a9a
        - name: skip
          in: query
          description: Optional - Offset for pagination
          required: false
          schema:
            type: integer
            description: Optional - Offset for pagination
            default: ''
            minimum: 0
            examples:
              - ''
        - name: limit
          in: query
          description: Optional - Number of results to return
          required: false
          schema:
            type: integer
            description: Optional - Number of results to return
            default: ''
            minimum: 1
            examples:
              - '10'
        - name: tags
          in: query
          description: >-
            Optional - Allow 1 or more tag as filter, separated by comma  (e.g.
            6835fffd1710b6f930a27f47, 6835fffd1710b6f930a27f13)
          required: false
          schema:
            type: string
        - name: email
          in: query
          description: Optional - Filter by email address
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  accounts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        email:
                          type: string
                        status:
                          type: string
                        warmup_status:
                          type: string
                        warmup_enb_dt:
                          type: string
                          description: warmup enabled time
                        timestamp_created:
                          type: string
                        timestamp_updated:
                          type: string
                        payload:
                          type: object
                          properties:
                            name:
                              type: object
                              properties:
                                first_name:
                                  type: string
                                last_name:
                                  type: string
                              required:
                                - first_name
                                - last_name
                              x-apidog-orders:
                                - first_name
                                - last_name
                            warmup:
                              type: object
                              properties:
                                limit:
                                  type: integer
                                warmup_custom_words:
                                  type: string
                                warmup_signature:
                                  type: integer
                                advanced:
                                  type: object
                                  properties:
                                    warm_ctd:
                                      type: boolean
                                    weekday_only:
                                      type: boolean
                                    warmup_business_type:
                                      type: string
                                  required:
                                    - warm_ctd
                                    - weekday_only
                                    - warmup_business_type
                                  x-apidog-orders:
                                    - warm_ctd
                                    - weekday_only
                                    - warmup_business_type
                                increment:
                                  type: integer
                                reply_rate:
                                  type: integer
                              required:
                                - limit
                                - warmup_custom_words
                                - warmup_signature
                                - advanced
                                - increment
                                - reply_rate
                              x-apidog-orders:
                                - limit
                                - warmup_custom_words
                                - warmup_signature
                                - advanced
                                - increment
                                - reply_rate
                            daily_limit:
                              type: integer
                            sending_gap:
                              type: integer
                              description: sending interval in minutes
                            reply_to:
                              type: string
                            custom_domain:
                              type: string
                            signature:
                              type: string
                            tags:
                              type: array
                              items:
                                type: string
                              description: list of associated tag ids
                            cmps:
                              type: array
                              items:
                                type: string
                              description: list of associated campaign ids
                            analytics:
                              type: object
                              properties:
                                health_scores:
                                  type: object
                                  properties:
                                    7d_overall_warmup_health:
                                      type: integer
                                      description: >-
                                        overall warmup health score over past 7
                                        days  (e.g. 100 = 100%)
                                    7d_google_warmup_health:
                                      type: integer
                                      description: >-
                                        warmup health score (Google recipient)
                                        over past 7 days  (e.g. 100 = 100%)
                                    7d_microsoft_warmup_health:
                                      type: integer
                                      description: >-
                                        warmup health score (Microsoft
                                        recipient) over past 7 days  (e.g. 100 =
                                        100%)
                                    7d_other_warmup_health:
                                      type: integer
                                      description: >-
                                        warmup health score (Other recipient)
                                        over past 7 days  (e.g. 100 = 100%)
                                  required:
                                    - 7d_overall_warmup_health
                                    - 7d_google_warmup_health
                                    - 7d_microsoft_warmup_health
                                    - 7d_other_warmup_health
                                  x-apidog-orders:
                                    - 7d_overall_warmup_health
                                    - 7d_google_warmup_health
                                    - 7d_microsoft_warmup_health
                                    - 7d_other_warmup_health
                                  description: warmup health score
                                reply_rates:
                                  type: object
                                  properties:
                                    7d_ooo_replyrate:
                                      type: integer
                                      description: >-
                                        Reply Rate (including OOO) over past 7
                                        days. -1 = N/A
                                    7d_replyrate:
                                      type: integer
                                      description: Reply Rate over past 7 days. -1 = N/A
                                  required:
                                    - 7d_ooo_replyrate
                                    - 7d_replyrate
                                  x-apidog-orders:
                                    - 7d_ooo_replyrate
                                    - 7d_replyrate
                                daily_counters:
                                  type: object
                                  properties:
                                    email_sent_today:
                                      type: integer
                                    warmup_email_sent_today:
                                      type: integer
                                  required:
                                    - email_sent_today
                                    - warmup_email_sent_today
                                  x-apidog-orders:
                                    - email_sent_today
                                    - warmup_email_sent_today
                              required:
                                - health_scores
                                - reply_rates
                                - daily_counters
                              x-apidog-orders:
                                - health_scores
                                - reply_rates
                                - daily_counters
                          required:
                            - name
                            - warmup
                            - daily_limit
                            - sending_gap
                            - reply_to
                            - custom_domain
                            - signature
                            - tags
                            - cmps
                            - analytics
                          x-apidog-orders:
                            - name
                            - warmup
                            - daily_limit
                            - sending_gap
                            - reply_to
                            - custom_domain
                            - signature
                            - tags
                            - cmps
                            - analytics
                        provider:
                          type: string
                      x-apidog-orders:
                        - id
                        - email
                        - status
                        - warmup_status
                        - provider
                        - warmup_enb_dt
                        - timestamp_created
                        - timestamp_updated
                        - payload
                      required:
                        - provider
                  current:
                    type: number
                    description: The current number of connected accounts
                  max_allowed:
                    type: number
                    description: The maximum allowed accounts under the plan
                required:
                  - accounts
                  - current
                  - max_allowed
                x-apidog-orders:
                  - accounts
                  - current
                  - max_allowed
              example:
                accounts:
                  - _id: 6606d3a757aebe86b6dd8b9c
                    email: alice.smith@example.com
                    status: ACTIVE
                    warmup_status: ACTIVE
                    provider: MICROSOFT365
                    timestamp_created: '2024-05-17T06:06:01.759Z'
                    timestamp_updated: '2024-08-14T13:08:37.344Z'
                    payload:
                      name:
                        first_name: Bob
                        last_name: Johnson
                      warmup:
                        limit: 75
                        warmup_custom_words: charity-dreamy
                        warmup_signature: 0
                        advanced:
                          warm_ctd: true
                          weekday_only: true
                          warmup_business_type: ''
                        increment: 2
                        reply_rate: 40
                      imap_host: imap.gmail.com
                      imap_port: 993
                      smtp_host: smtp.gmail.com
                      smtp_port: 465
                      daily_limit: 100
                      sending_gap: 5
                      reply_to: ''
                      custom_domain: ''
                      signature: ''
                      tags: []
                      cmps: []
                      analytics:
                        health_scores:
                          7d_overall_warmup_health: 100
                          7d_google_warmup_health: 100
                          7d_microsoft_warmup_health: 100
                          7d_other_warmup_health: 100
                        reply_rates:
                          7d_ooo_replyrate: 4.3
                          7d_replyrate: 3.1
                        daily_counters:
                          email_sent_today: 10
                          warmup_email_sent_today: 1
                  - _id: 6634af3e716bada4a591a386
                    email: bob.johnson@example.com
                    status: ACTIVE
                    warmup_status: ACTIVE
                    provider: GOOGLE_WORKSPACE
                    timestamp_created: '2024-05-03T09:32:44.243Z'
                    timestamp_updated: '2024-07-25T15:46:59.015Z'
                    payload:
                      name:
                        first_name: Bob
                        last_name: Johnson
                      warmup:
                        limit: 75
                        warmup_custom_words: charity-dreamy
                        warmup_signature: 0
                        advanced:
                          warm_ctd: true
                          weekday_only: true
                          warmup_business_type: ''
                        increment: 2
                        reply_rate: 40
                      imap_host: imap.gmail.com
                      imap_port: 993
                      smtp_host: smtp.gmail.com
                      smtp_port: 465
                      daily_limit: 100
                      sending_gap: 5
                      reply_to: ''
                      custom_domain: ''
                      signature: ''
                      tags: []
          headers: {}
          x-apidog-name: OK
        '400':
          description: Validation or other error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: ''
                    examples:
                      - Validation error
                  error:
                    type: string
                    description: ''
                    examples:
                      - Validation error
                x-apidog-orders:
                  - message
                  - error
          headers: {}
          x-apidog-name: Bad Request
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
          headers: {}
          x-apidog-name: Server Error
      security: []
      x-apidog-folder: For Email Infra Provider Partner
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/929054/apis/api-25729696-run
components:
  schemas: {}
  securitySchemes:
    ApiKeyAuth:
      type: apikey
      in: header
      name: x-api-key
      description: |
        API key issued in the PlusVibe dashboard. The server reads it
        from the `x-api-key` header and injects it into the request as
        the `api_key` query parameter, which is why you will see
        `api_key` referenced in validation errors.
    apiKey:
      type: apikey
      in: body
      name: api_key
      description: API key passed in request body
servers:
  - url: https://api.plusvibe.ai/api/v1
    description: Prod Env
security:
  - ApiKeyAuth: []
    x-apidog:
      schemeGroups:
        - id: uS5KiuC4wfZHK42AzOfA_
          schemeIds:
            - ApiKeyAuth
      required: true
      use:
        id: uS5KiuC4wfZHK42AzOfA_
      scopes:
        uS5KiuC4wfZHK42AzOfA_:
          ApiKeyAuth: []

```
