Intercom API (unofficial showcase)
GET/ip_allowlist

Get IP allowlist settings

Retrieves the current IP allowlist configuration for the workspace. Use the returned enabled value and ip_allowlist entries to inspect whether the allowlist is active and which IP addresses or ranges are allowed.

1 parameter
Intercom-Versionstringoptional
Selects the API version. Defaults to `2.17` when omitted; supported versions include 1.0 through 1.4 and 2.0 through 2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

2 status codes
200Returns the workspace IP allowlist configuration, including whether it is enabled and the allowed IP addresses or CIDR ranges.
typestringoptional
String representing the object's type. Always has the value `ip_allowlist`.
enabledbooleanoptional
Whether the IP allowlist is enabled for the workspace.
ip_allowlistarray<string>optional
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)
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized; the Intercom-Version header selects the API version and does not provide authentication.