One connection list

GET/account/api/v1/residential/lists/{id}

Authorization

Authorization	`Bearer YOUR_ARNPROXY_API_KEY`
Required permission	`read + optional credentials`
Accept	`application/json`

Parameters

Name	Type	Description
`id` pathRequired	`integer`	An owned record ID for this operation; 1–2147483647. Not a display order number or supplier ID.
`include_credentials` queryOptional	`string`	"0" or "1"; default "0". "1" needs credentials permission and valid service. Default: `"0"`

Request example

cURL

printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    'https://www.arnproxy.com/account/api/v1/residential/lists/YOUR_LIST_ID'

Examples are not executed on this page. Keep the API key in a server-side environment variable; do not put real keys in URLs or browser code. Prepare request.json for POST examples.

Responses

200Success response

application/json

{
    "ok": true,
    "data": {
        "id": 30001,
        "package_id": 20001,
        "order_id": 20001,
        "title": "Example connection list",
        "package_state": "active",
        "snapshot": {
            "source": "arnproxy_records",
            "observed_at": "2030-01-01T12:00:00+00:00",
            "fresh": true,
            "max_age_seconds": 3600,
            "reason": null
        },
        "connection": {
            "host": "res.arnproxy.com",
            "first_port": 10000,
            "port_count": 10
        },
        "authentication": "login_password",
        "target": {
            "country": "US",
            "region": "",
            "city": "",
            "isp": ""
        },
        "rotation": {
            "type": "interval",
            "seconds": 0
        },
        "credential_read_available": true,
        "management_available": true,
        "management_actions": [
            "rename",
            "rotation",
            "delete"
        ]
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}

Response fields and types

Name	Type	Description
`ok`	`boolean`	Success envelope flag; on false inspect error.code.
`data`	`object`	Operation-specific result; examples are illustrative and synthetic.
`data.id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.package_id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.order_id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.title`	`string`	Operation-specific title value; preserve its demonstrated type and consult the behavior notes.
`data.package_state`	`string`	Operation-specific package state value; preserve its demonstrated type and consult the behavior notes.
`data.snapshot`	`object`	Package snapshot origin/time/freshness; stale snapshots do not grant management access.
`data.snapshot.source`	`string`	Data source; local records and a live provider lookup are different evidence.
`data.snapshot.observed_at`	`string`	Timestamp in the API’s returned representation; example dates are synthetic.
`data.snapshot.fresh`	`boolean`	Whether the observation satisfies its freshness window.
`data.snapshot.max_age_seconds`	`integer`	Maximum snapshot age allowed for freshness, in seconds.
`data.snapshot.reason`	`string\|null`	Fixed reason code or null, never raw provider error text.
`data.connection`	`object`	List host, first port and port count; can be null for invalid observations.
`data.connection.host`	`string`	Operation-specific host value; preserve its demonstrated type and consult the behavior notes.
`data.connection.first_port`	`integer`	Start or size of the connection port range.
`data.connection.port_count`	`integer`	Start or size of the connection port range.
`data.authentication`	`string`	Connection list authentication mode: login_password or ip_auth.
`data.target`	`object`	Operation-specific target value; preserve its demonstrated type and consult the behavior notes.
`data.target.country`	`string`	Operation-specific country value; preserve its demonstrated type and consult the behavior notes.
`data.target.region`	`string`	Operation-specific region value; preserve its demonstrated type and consult the behavior notes.
`data.target.city`	`string`	Operation-specific city value; preserve its demonstrated type and consult the behavior notes.
`data.target.isp`	`string`	Operation-specific isp value; preserve its demonstrated type and consult the behavior notes.
`data.rotation`	`object`	Operation-specific rotation value; preserve its demonstrated type and consult the behavior notes.
`data.rotation.type`	`string`	Operation-specific type value; preserve its demonstrated type and consult the behavior notes.
`data.rotation.seconds`	`integer`	Recorded/requested rotation in seconds; Rotating packages and Residential lists have different rules.
`data.credential_read_available`	`boolean`	Operation-specific credential read available value; preserve its demonstrated type and consult the behavior notes.
`data.management_available`	`boolean`	Availability under the result’s conditions/permissions, not a stock or provider guarantee.
`data.management_actions`	`array`	Operation-specific management actions value; preserve its demonstrated type and consult the behavior notes.
`data.management_actions[]`	`string`	Operation-specific management actions value; preserve its demonstrated type and consult the behavior notes.
`meta`	`object`	Request correlation and data-source metadata.
`meta.request_id`	`string`	This HTTP request’s correlation ID, not an operation key or order ID.
`meta.phase`	`string`	Operation-specific phase value; preserve its demonstrated type and consult the behavior notes.
`meta.source`	`string`	Data source; local records and a live provider lookup are different evidence.
`data.credentials`Conditional	`object`	Only with include_credentials=1, credentials permission, an active package and a login_password list.
`data.credentials.username`Conditional	`string`	Connection-list username.
`data.credentials.password`Conditional	`string`	Connection-list password.
`data.authorized_ips`Conditional	`string[]\|null`	May be returned for an IP-auth list with residential_management permission.

Error response

HTTP 401 · INVALID_API_KEY

{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

Authentication and validation may reject a request before execution. Consult the error reference and retain request_id when contacting support. Never send keys or passwords. Errors & limits →

Behavior & important notes

Package and list IDs are ARNPROXY record IDs, not upstream package keys or list IDs. A stale package snapshot cannot grant access; refresh it with residential_package_refresh when needed.
Credential-bearing output requires credentials permission. Never log or send returned connection strings, passwords or Authorization headers to support.