Skip to content

Retrieve an IP list

GET
/api/organizations/{organizationId}/ip-lists/{id}

Returns a single IP list by ID, including its name, description, and entries.

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext).

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Path Parameters

organizationId*

Organization identifier

Type
string
Required
id*

ip-list identifier

Type
string
Required

Responses

ip-list resource

JSON
{
  
"@context": "string",
  
"@id": "string",
  
"@type": "string",
  
"id": "0197c9a3-5f2e-7b41-9c8d-1a2b3c4d5e6f",
  
"organization": "https://example.com/",
  
"name": "Office allowlist",
  
"description": "Corporate office egress ranges",
  
"entries": [
  
  
[
  
  
  
"203.0.113.0/24",
  
  
  
"198.51.100.7",
  
  
  
"2001:db8::/32"
  
  
]
  
],
  
"createdAt": "2026-07-01T12:00:00+00:00",
  
"updatedAt": "2026-07-01T12:00:00+00:00"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI