---
title: "View IP Auth"
method: POST
path: "/ip_auth/view"
tags: ["IP AUTH"]
---

# View IP Auth

`POST /ip_auth/view`

Returns a list of all IP Auth entries that are managed by this account, or details of a specific IP Auth, when you include the [ip_address] in your request. If no entries are available, this will return an empty list.

## Request body

- object
  - `ip_address` string — If passed, a valid ip address of an existing IP Auth entry that you wish to view
  - `subaccount_id` string — If you wish to make this API call on behalf of a subaccount then include its unique ID here

## Response `200`

List of IP Auth entries

- object
  - `request_id` string, required
  - `data` object, required
    - `results` object[], required
      - `comments` string
      - `ip_addres` string, required
      - `email_password` string
      - `sending_allowed` boolean, required
      - `custom_ratelimit` boolean, required
      - `custom_ratelimit_value` integer, nullable
      - `custom_ratelimit_period` string
      - `default_ratelimit_value` string — The default limit of emails this IP Auth user can send in the period specified in <code>default_ratelimit_period</code>. <strong>Note:</strong> Used if <code>custom_ratelimit</code> is false.
      - `default_ratelimit_period` string — The default period for which this IP Auth will be limited to the number of emails specified in <code>default_ratelimit_value</code>.<br><br><strong>Syntax:</strong> "\<n\> [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]".<br><br><strong>Examples: </strong> "0:30:00", "1 hour", "2 days", "3 months", "4 months 5:00:00".<br><br><strong>Note:</strong> Used if <code>custom_ratelimit</code> is false.
      - `ippool` integer
      - `description` string
      - `feedback_enabled` boolean
      - `feedback_domain` string
      - `feedback_html` string
      - `feedback_text` string
      - `archive_enabled` boolean
      - `open_tracking_enabled` boolean
      - `audit_email` string, nullable
      - `bounce_notifications` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/smtp2go/apis/smtp2go-api-v3-0-4.md) · [All operations](https://skmtc.net/smtp2go/apis/smtp2go-api-v3-0-4/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smtp2go/smtp2go-api-v3-0-4/versions/1ba6b25eebb9/schema)