Skip to content
Home/
/IP Allowlist

IP Allowlist

Manage IP allowlist settings for your workspace.

The IP Allowlist API allows you to configure which IP addresses teammates can use your workspace from, in the web app and mobile apps. This is useful for restricting teammate access to specific corporate networks or VPNs. It doesn't apply to REST API requests, which use a separate REST API allowlist that this API doesn't manage.

Authentication

This endpoint requires the manage_ip_allowlist OAuth scope.

Operations

Get IP allowlist settings

Request

Retrieve the current IP allowlist configuration for the workspace.

Requires the manage_ip_allowlist OAuth scope.

Security
bearerAuth
Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:2.17
curl -i -X GET \
  https://api.intercom.io/ip_allowlist \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.17'

Responses

Successful response

Bodyapplication/json
typestring

String representing the object's type. Always has the value ip_allowlist.

Example:"ip_allowlist"
enabledboolean

Whether the IP allowlist is enabled for the workspace.

Example:true
ip_allowlistArray of strings

List of allowed IP addresses and/or IP ranges in CIDR notation. Examples:

  • Single IP: 192.168.0.1
  • IP range: 192.168.0.1/24 (allows 192.168.0.0 - 192.168.0.255)
Example:
[
  "192.168.1.0/24",
  "10.0.0.1"
]
Response
{
  "type": "ip_allowlist",
  "enabled": true,
  "ip_allowlist": [
    "192.168.1.0/24",
    "10.0.0.1"
  ]
}