Pular para o conteúdo principal
GET
/
v1
/
deadlines
Listar Prazos
curl --request GET \
  --url https://reporter.sandbox.lerian.net/v1/deadlines \
  --header 'X-Organization-id: <x-organization-id>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "type": "<string>",
      "frequency": "<string>",
      "dueDate": "<string>",
      "color": "<string>",
      "notifyDaysBefore": 123,
      "monthsOfYear": [
        123
      ],
      "templateId": "<string>",
      "templateName": "<string>",
      "status": "<string>",
      "active": true,
      "deliveredAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "page": 123,
  "limit": 123,
  "total": 123
}

Cabeçalhos

Authorization
string

O token de autorização no formato 'Bearer '.

Importante: Este header é obrigatório se o seu ambiente tiver o Access Manager habilitado. Para mais informações, consulte a documentação do Access Manager.

X-Organization-id
string
obrigatório

O identificador único da Organização associada à requisição.

Parâmetros de consulta

status
enum<string>

Filtra os prazos por status. Valores permitidos: pending, overdue, delivered.

Opções disponíveis:
pending,
overdue,
delivered
limit
integer
padrão:10

Número de registros retornados por página. Deve ser um inteiro maior ou igual a 1.

page
integer
padrão:1

Número da página a ser retornada. Deve ser um inteiro maior ou igual a 1.

Resposta

A lista de prazos no sistema.

items
object[]

Lista de prazos retornados para a página atual.

page
integer

Número da página retornada.

limit
integer

Número máximo de registros retornados por página.

total
integer

Número de registros retornados na página atual.