Saltar al contenido principal
GET
/
v1
/
deadlines
Listar plazos
curl --request GET \
  --url https://reporter.sandbox.lerian.net/v1/deadlines
{
  "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
}

Encabezados

Authorization
string

El token de autorización en formato 'Bearer '.

Importante: Este encabezado es obligatorio si su entorno tiene habilitado Access Manager. Para obtener más información, consulte la documentación de Access Manager.

X-Organization-id
string

The unique identifier of the Organization associated with the request.

Parámetros de consulta

status
enum<string>

Filtra los plazos por estado. Valores permitidos: pending, overdue, delivered.

Opciones disponibles:
pending,
overdue,
delivered
limit
integer
predeterminado:10

Número de registros devueltos por página. Debe ser un entero mayor o igual a 1.

page
integer
predeterminado:1

Número de página a devolver. Debe ser un entero mayor o igual a 1.

Respuesta

La lista de plazos en el sistema.

items
object[]

Lista de plazos devueltos para la página actual.

page
integer

Número de la página devuelta.

limit
integer

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

total
integer

Número de registros devueltos en la página actual.