Skip to content

List IP lists

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

Returns every IP list belonging to the organization. Use the "name" query parameter to filter by a partial (substring) match on the list name.

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

Query Parameters

page

The collection page number

Type
integer
Default
1
itemsPerPage

The number of items per page

Type
integer
Default
30
Minimum
0
Maximum
100
name

Filter IP lists by a partial (substring) match on the name.

Type
string
name[]

Filter IP lists by a partial (substring) match on the name.

Type
array

Responses

ip-list collection

JSON
{
  
"totalItems": 0,
  
"search": {
  
  
"@type": "string",
  
  
"template": "string",
  
  
"variableRepresentation": "string",
  
  
"mapping": [
  
  
  
{
  
  
  
  
"@type": "string",
  
  
  
  
"variable": "string",
  
  
  
  
"property": "string",
  
  
  
  
"required": true
  
  
  
}
  
  
]
  
},
  
"view": {
  
  
"@id": "string",
  
  
"@type": "string",
  
  
"first": "string",
  
  
"last": "string",
  
  
"previous": "string",
  
  
"next": "string"
  
},
  
"member": [
  
  
{
  
  
  
"@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