Webhooks

Lista as subscriptions da conta

Lista as subscriptions da conta, paginadas e ordenadas pela data de criação. Total é a quantidade total de subscriptions da conta, não o tamanho da página.

get/v1/webhooks/subscriptions

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/webhooks/subscriptions
  • Auth: none declared. Required headers: X-Api-Id, X-Api-Key, X-Use-ApiGateway

Query parameters

limitinteger

Tamanho da página. Padrão 50, mínimo 1, máximo 200. Valor fora desse intervalo retorna 400.

pageinteger

Número da página, começando em 1. Padrão 1. Valor menor que 1 retorna 400.

Headers

X-Api-Idstring required

API ID usado para autenticação.

X-Api-Keystring required

API KEY usado para autenticação.

X-Use-ApiGatewaystring required

Este header indica que a request será roteada pelo API Gateway da Qive e o valor deve ser passado como always.

Response

Página de subscriptions.

Totalinteger

Total de registros da conta, não o tamanho da página.

Pageinteger

Página devolvida.

Limitinteger

Tamanho de página usado.

Example response

{
  "Subscriptions": [
    {
      "Id": "7c2d1e4f-5a6b-4c3d-8e9f-0a1b2c3d4e5f",
      "Owner": "19427033000140",
      "DocumentType": "nfe",
      "EventType": "document.received",
      "EndpointId": "0b9f6e2a-3c41-4d8e-9a57-2f1c6d8e4b10",
      "Active": true,
      "CreatedAt": "2026-10-05T12:00:00Z",
      "UpdatedAt": "2026-10-05T12:00:00Z"
    }
  ],
  "Total": 1,
  "Page": 1,
  "Limit": 50
}

Changes

No recorded changes to this operation across all 1 revision of this API.