List IP pools

GET 
/v1/ip-pool/list

Retrieve a list of IP pools with optional filtering

Request

Query Parameters

provider string

Possible values: [sparkpost]

Filter by Provider

page_token string

Page Token for pagination

Responses

200

OK

application/json

Schema

Schema

data

object

ip_pools

object[]

Array [

created_at string

deleted_at string

details

object

property name* any

pool_id string

provider string

]

next_page_token string

total_count integer
message string
success boolean

Example (from schema)

{
  "data": {
    "ip_pools": [
      {
        "created_at": "string",
        "deleted_at": "string",
        "details": {},
        "pool_id": "string",
        "provider": "string"
      }
    ],
    "next_page_token": "string",
    "total_count": 0
  },
  "message": "IP pools listed successfully",
  "success": true
}

400

Bad Request

application/json

Schema

Schema

details string
error string
success boolean

Example (from schema)

{
  "details": "string",
  "error": "string",
  "success": false
}

500

Internal Server Error

application/json

Schema

Schema

details string
error string
success boolean

Example (from schema)

{
  "details": "string",
  "error": "string",
  "success": false
}

Loading...