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

includeArchived
string

Incluir equipamentos arquivados na resposta (padrão: false).

Example:

"false"

status
enum<string>[]

Filtra pela situação do equipamento. Repita o parâmetro para incluir múltiplos valores (?status=in-use&status=available). Não inclui archived: use includeArchived=true para trazer equipamentos arquivados.

Available options:
available,
in-use,
allocated,
maintenance,
broken,
lost,
stolen,
sold,
donated,
discarded,
obsolete,
blocked,
pending-verification,
awaiting-quote
Example:

"in-use"

category
string[]

Filtra pela categoria exata do equipamento. Repita o parâmetro para incluir múltiplos valores. Use __null__ para filtrar equipamentos sem categoria definida.

Example:

"notebook"

employeeId
string[]

Filtra equipamentos pelos colaboradores vinculados. Repita o parâmetro para incluir múltiplos valores. Use __null__ para trazer equipamentos sem colaborador vinculado.

serialNumber
string

Filtra pelo número de série exato do equipamento.

Example:

"SN1234567890"

enrollmentId
string

Filtra pelo número de patrimônio exato do equipamento.

Example:

"SLY-12345"

createdAtFrom
string<date-time>

Filtra equipamentos criados 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 equipamentos criados 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,
enrollmentId,
category
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