Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
required

Número da página, iniciando em 1.

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

1

pageSize
integer
default:50
required

Tamanho da página. Máximo de 200.

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

50

status
enum<string>[]

Filtra pelo status público da linha. Repita o parâmetro para incluir múltiplos valores (?status=active&status=blocked).

Available options:
pending,
available,
active,
partial-block,
blocked,
canceled
Example:

"active"

productType
enum<string>[]

Filtra pelo tipo de produto da linha. Repita o parâmetro para incluir múltiplos valores.

Available options:
mobile,
mobile-did,
landline-did,
global
Example:

"mobile"

phoneNumber
string

Filtra pelo número que o cliente reconhece como sendo da linha, no formato E.164: casa o número ativo na linha, o número escolhido ou a portar antes da ativação, e o número de uma portabilidade em andamento ou que falhou. Uma linha pode ser encontrada por um número que ela não exibe — por exemplo uma linha cancelada cuja portabilidade não se concluiu —, então compare com phoneNumber no resultado.

Example:

"+5541999887766"

employeeId
string[]

Filtra pelas linhas associadas aos colaboradores informados. Repita o parâmetro para incluir múltiplos valores (?employeeId=...&employeeId=...).

costCenterId
string[]

Filtra pelo centro de custo da linha. Repita o parâmetro para incluir múltiplos valores. Use __null__ para filtrar linhas sem centro de custo definido.

Example:

"0198c2f1-3815-45b7-9e60-8e137cad845c"

createdAtFrom
string<date-time>

Filtra linhas criadas a partir desta data (inclusivo), em formato ISO8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-05-01T00:00:00Z"

createdAtTo
string<date-time>

Filtra linhas criadas até esta data (exclusivo), em formato ISO8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-06-01T00:00:00Z"

activatedAtFrom
string<date-time>

Filtra linhas ativadas a partir desta data (inclusivo), em formato ISO8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-05-01T00:00:00Z"

activatedAtTo
string<date-time>

Filtra linhas ativadas até esta data (exclusivo), em formato ISO8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-06-01T00:00:00Z"

canceledAtFrom
string<date-time>

Filtra linhas canceladas a partir desta data (inclusivo), em formato ISO8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-05-01T00:00:00Z"

canceledAtTo
string<date-time>

Filtra linhas canceladas até esta data (exclusivo), em formato ISO8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-06-01T00:00:00Z"

sortBy
enum<string>

Campo usado para ordenar o resultado. Padrão: createdAt.

Available options:
createdAt,
activatedAt,
name
Example:

"createdAt"

sortOrder
enum<string>

Direção da ordenação. Padrão: desc.

Available options:
asc,
desc
Example:

"desc"

Response

data
object[]
required
pagination
object
required