# List all email accounts in the workspace ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /account/list: 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. operationId: Email Account_email-account/list-all-email-accounts-in-the-workspace tags: - Email Account - Email Account parameters: - 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 - name: x-api-key in: header description: | Your PlusVibe.ai account's API Key required: true example: '' schema: type: string description: | Your PlusVibe.ai account's API Key default: '' examples: - your-api-key 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 warmup_rampup: type: object description: >- Warmup ramp-up settings. Gradually increases the daily warmup volume from an initial daily limit. Round-trips with the warmup ramp-up write params on bulk-update. properties: is_slow_rampup: type: boolean description: >- Whether slow ramp-up is enabled for warmup (maps to is_warmup_slow_rampup). initial_daily_limit: type: integer description: >- Starting daily warmup volume the ramp-up grows from (maps to warmup_initial_daily_limit). randomize: type: boolean description: >- Whether the daily warmup volume is randomized (maps to warmup_randomize). randomize_num: type: integer description: >- Randomization range applied to the daily warmup volume (maps to warmup_randomize_num). required: - is_slow_rampup - initial_daily_limit - randomize - randomize_num x-apidog-orders: - is_slow_rampup - initial_daily_limit - randomize - randomize_num daily_limit: type: integer sending_gap: type: integer description: sending interval in minutes sending_rampup: type: object description: >- Sending ramp-up settings. Gradually increases the daily sending volume from a starting limit. Round-trips with the sending ramp-up write params on bulk-update. properties: is_slow_rampup: type: boolean description: Whether slow ramp-up is enabled for sending rampup_daily_limit: type: integer description: >- Starting daily sending volume the ramp-up grows from rampup_daily_inc: type: integer description: >- Number of emails added to the daily sending volume each step required: - is_slow_rampup - rampup_daily_limit - rampup_daily_inc x-apidog-orders: - is_slow_rampup - rampup_daily_limit - rampup_daily_inc 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%) 1d_miss_warmup_rate: type: integer description: >- Previous day's warmup missing rate. 100 = All missing, 0 = All detected In Inbox/Promotion/Spam 3d_bounce_rate: type: integer description: >- Bounce rate over past 3 days. Equals to -1 (not avaliable) if fewer than 10 sent emails required: - 7d_overall_warmup_health - 7d_google_warmup_health - 7d_microsoft_warmup_health - 7d_other_warmup_health - 1d_miss_warmup_rate - 3d_bounce_rate x-apidog-orders: - 7d_overall_warmup_health - 7d_google_warmup_health - 7d_microsoft_warmup_health - 7d_other_warmup_health - 1d_miss_warmup_rate - 3d_bounce_rate 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 - warmup_rampup - daily_limit - sending_gap - sending_rampup - reply_to - custom_domain - signature - tags - cmps - analytics x-apidog-orders: - name - warmup - warmup_rampup - daily_limit - sending_gap - sending_rampup - 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 required: - accounts x-apidog-orders: - accounts 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 warmup_rampup: is_slow_rampup: true initial_daily_limit: 20 randomize: true randomize_num: 3 imap_host: imap.gmail.com imap_port: 993 smtp_host: smtp.gmail.com smtp_port: 465 daily_limit: 100 sending_gap: 5 sending_rampup: is_slow_rampup: true rampup_daily_limit: 20 rampup_daily_inc: 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 1d_miss_warmup_rate: 0 3d_bounce_rate: 3 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 warmup_rampup: is_slow_rampup: false initial_daily_limit: 0 randomize: false randomize_num: 0 imap_host: imap.gmail.com imap_port: 993 smtp_host: smtp.gmail.com smtp_port: 465 daily_limit: 100 sending_gap: 5 sending_rampup: is_slow_rampup: false rampup_daily_limit: 0 rampup_daily_inc: 0 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: - ApiKeyAuth: [] x-apidog: schemeGroups: - id: uS5KiuC4wfZHK42AzOfA_ schemeIds: - ApiKeyAuth required: true use: id: uS5KiuC4wfZHK42AzOfA_ scopes: uS5KiuC4wfZHK42AzOfA_: ApiKeyAuth: [] x-apidog-folder: Email Account x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/929054/apis/api-17238014-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: [] ```