Skip to main content
GET
/
api
/
v2
/
plan
/
list
Retrieve agent plan list
curl --request GET \
  --url https://api.okeyproxy.com/ipglobal-api/api/v2/plan/list
{
  "details": [
    {
      "planId": "20250101114300769",
      "proxyType": 2,
      "traffic": 1,
      "availableTraffic": 1,
      "effectTime": "2025-01-01 11:43:00",
      "expireTime": "2025-01-01 11:43:00",
      "secUsername": "ancd1p32b",
      "status": 1
    }
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 10,
    "totalRecords": 4,
    "totalPages": 1
  }
}

Query Parameters

apiKey
string
required

Agent API key used for authentication

startTime
string
required

Start time, in yyyy-MM-dd HH:mm:ss format (UTC+8)

endTime
string
required

End time, in yyyy-MM-dd HH:mm:ss format (UTC+8)

page
integer
default:1

Current page number (default: 1)

pageSize
integer
default:20

Number of records per page (default: 20, maximum: 100)

Required range: x <= 100

Response

200 - application/json
details
Plan details · object[]
required
pagination
Pagination metadata · object
required