Skip to main content
GET
Reservas
Lista reservas do CRM.
Autenticação: Authorization: Bearer SEU_JWT.

Obrigatório

companyId, userId.

Campos

Exemplo de resposta

Resposta

Sucesso: success é true, code é SUCCESS e o conteúdo vem em data. Falha de regra traz message, status e code. Falha de validação traz error. O índice está em Erros e códigos.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir o JWT da conta no header Authorization no formato Bearer. Sem esse header a requisição é recusada.

Path Parameters

companyId
string
required

Empresa da sessão.

Example:

"UUID_DA_EMPRESA"

userId
string
required

Usuário da sessão.

Example:

"UUID_DO_USUARIO"

Query Parameters

status
string

Opcional na query.

Example:

"exemplo"

typeReservationId
integer

Opcional na query.

Example:

1

unitId
string

Opcional na query.

Example:

"1"

startsFrom
string

Opcional na query.

Example:

"exemplo"

startsTo
string

Opcional na query.

Example:

"exemplo"

mine
string

Opcional na query.

Example:

"exemplo"

Response

A operação concluiu. success é true, code é SUCCESS e o conteúdo vem em data.

success
boolean
required
Example:

true

data
any
required

Conteúdo da operação. O exemplo 200 de cada rota preenche os campos do recurso.

code
string
required
Example:

"SUCCESS"