Skip to main content
GET
Get Lines

Authorizations

x-api-key
string
header
required

API Key

Query Parameters

offset
integer | null
default:0

The offset for the returned lines. Should be a non-negative integer.

Required range: x >= 0
Example:

0

limit
integer
default:20

The number of lines to return. Should be an integer between 1 and 100.

Required range: 1 <= x <= 100
Example:

20

status
enum<string>
default:all

Status of the returned lines. Possible values: 'all', 'active', 'suspended', 'expiring'.

Available options:
all,
active,
suspended,
expiring
type
enum<string>
default:all

Type of the line to return. Possible values: 'all', 'premium', 'trial'.

Available options:
all,
premium,
trial

Search lines by partial username or line ID.

Example:

"demo"

orderBy
enum<string>
default:id

Field to sort lines by. Possible values: 'id', 'username', 'enabled', 'exp_date'.

Available options:
id,
username,
enabled,
exp_date
orderType
enum<string>
default:asc

Type of sort. Possible values: 'asc', 'desc'.

Available options:
asc,
desc

Response

Returns a list of lines.

offset
integer
required

The offset used for the current response.

Required range: x >= 0
Example:

0

limit
integer
required

The requested page size for the current response.

Required range: x >= 1
Example:

20

totalHits
number
required

The total number of lines available. (Helpfull for pagination)

totalReturns
number
required

The number of lines returned in the current response.

hasNextPage
boolean
required

Whether another page of results is available after this one.

Example:

true

hasPreviousPage
boolean
required

Whether a previous page of results exists before this one.

Example:

false

nextOffset
integer | null
required

The offset to request the next page, or null when there is no next page.

Required range: x >= 0
Example:

20

previousOffset
integer | null
required

The offset to request the previous page, or null when there is no previous page.

Required range: x >= 0
Example:

null

lines
object[]
required
Last modified on May 22, 2026