Webhooks

Lista os endpoints cadastrados na conta

Lista os endpoints da conta, paginados e ordenados pela data de cadastro. Total é a quantidade total de endpoints da conta, não o tamanho da página. Uma página além do fim devolve a lista vazia com Total igual a 0.

get/v1/webhooks/endpoints

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/webhooks/endpoints
  • 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 endpoints.

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

{
  "Endpoints": [
    {
      "Id": "0b9f6e2a-3c41-4d8e-9a57-2f1c6d8e4b10",
      "Url": "https://erp.exemplo.com.br/webhooks/qive",
      "Status": "active",
      "VerifiedAt": "2026-10-05T12:00:00Z",
      "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.