Pular para o conteúdo

Valem as mesmas regras de visibilidade do painel: serviços totalmente vencidos ficam ocultos por padrão. Com state, você pode filtrar pelo estado exibido no painel.

Um parâmetro desconhecido ou um valor inválido retorna 400 invalid_request; details.field informa qual é o parâmetro.

O endpoint de lista não traz estatísticas. Ele foi mantido leve de propósito, já que seria preciso consultar o backend para cada serviço; obtenha os dados de uso no endpoint Detalhes do serviço.

Autorização

Authorizationstringobrigatório

Enviado no formato Bearer <token>. Este endpoint exige o escopo orders:read (Informações do serviço); um token sem esse escopo recebe 403.

Parâmetros de consulta

typeenum<string>

Filtra por tipo de serviço.

statusstring

Filtra pelo status bruto.

stateenum<string>

Filtra pelo estado exibido no painel. Com expired, os serviços totalmente vencidos também são listados. Os valores estão na página Estados do serviço.

limitintegerpadrão: 25

Registros por página: 1-100. 0, um valor negativo ou não inteiro retorna 400; valores acima de 100 são reduzidos a 100 (meta.limit mostra o valor aplicado).

offsetintegerpadrão: 0

Número de registros a pular.

include_expiredboolean

true lista também os serviços totalmente vencidos e cancelados. É ativado automaticamente quando status=expired ou cancelled é informado.

Resposta

200
application/json
dataobject[]
metaobject