Skip to content

List residential sub-users

GET
/proxies/residential/subusers
curl --request GET \
--url 'https://api.ltesocks.io/v2/proxies/residential/subusers?page_size=10' \
--header 'Authorization: Bearer <token>'

Requires an active linked top-level Master or Regular account and enabled residential sub-user management. Slave accounts cannot manage children. Send Authorization: Bearer . Token ability: proxy.residential.subusers.index (or *). Supply page or page_size to enable pagination, with 10 records per page. If only page_size is supplied, page defaults to 1. With neither parameter the response contains the full list without page_info. No search query is supported by this public endpoint.

page
integer
>= 1 <= 214748364

Page number. Omit both pagination parameters for an unpaginated list.

page_size
integer
Allowed values: 10

Fixed page size. Supplying this parameter enables pagination.

List residential sub-users succeeded.

Media typeapplication/json
object
success
required
boolean
code
required
integer
data
required
Array<object>
object
id

LTESocks child UUID used in management URLs.

string format: uuid
login
string
email
string
nullable
first_name
string
nullable
last_name
string
nullable
status
string
package_id
string format: uuid
traffic_bytes

Allocated quota in bytes.

integer format: int64
nullable
used_bytes

Consumed traffic in bytes.

integer format: int64
nullable
remaining_bytes

Remaining traffic in bytes.

integer format: int64
nullable
allowed_ips
Array<string>
blocked_domains
Array<string>
created_at

Creation timestamp.

string
nullable
page_info
object
page
required
integer
>= 1
page_size
required
integer
Allowed values: 10
total_count
required
integer
Examples
Exampleresponse
{
"success": true,
"code": 200,
"data": [
{
"id": "11111111-1111-4111-8111-111111111111",
"login": "parent_customer01",
"email": "parent_customer01@example.test",
"first_name": null,
"last_name": null,
"status": "active",
"package_id": "22222222-2222-4222-8222-222222222222",
"traffic_bytes": 1073741824,
"used_bytes": 0,
"remaining_bytes": 1073741824,
"allowed_ips": [],
"blocked_domains": [],
"created_at": "2026-10-21T12:00:00Z"
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_count": 1
}
}

Missing or invalid bearer token.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Inactive or unsupported account, insufficient token ability, or child ownership denied.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Sub-user or linked residential account not found, or residential sub-user management is disabled.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Conflicting operation or duplicate user.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Invalid input, insufficient available traffic, incompatible package, or quota limit exceeded.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Request rate limit exceeded.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Internal service error.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Residential service failed or its result could not be read.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Residential service temporarily unavailable.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}