Skip to navigation

Buscar por parâmetros

Devolve as assinaturas de webhook do seu ambiente.

Authentication

x-api-keystring
API Key authentication via header

Query parameters

criteriastringOptional

O critério observado. Sem modificador, casa o que começa com o valor, ignorando maiúsculas e acentos.

criteria:containsstringOptional

O critério observado, casando o valor em qualquer posição.

criteria:exactstringOptional

O critério observado, idêntico ao valor — maiúsculas e acentos incluídos.

statusstringOptional

O estado da assinatura: requested, active, error ou off. Aceita vários estados, separados por vírgula ou repetindo o parâmetro, e devolve as assinaturas que estejam em qualquer um deles.

_tagstringOptional

A etiqueta da assinatura, na sintaxe system|code — é o caminho para reencontrar uma assinatura específica.

urlstringOptional
A URL de destino da assinatura, comparada por igualdade.
url:belowstringOptional

As assinaturas cuja URL de destino começa pelo valor.

url:abovestringOptional

As assinaturas cuja URL de destino é um prefixo do valor.

_countintegerOptional

Quantidade de registros por página.

Response

Operação bem sucedida.

resourceTypestringDefaults to Bundle
Indica o tipo do recurso transacionado.
typeenum

Constante searchset neste endpoint.

Allowed values:
entrylist of objectsOptional

Uma entrada por assinatura encontrada. Vazia quando não há resultados.

Errors

400
Bad Request Error