Listar execuções de vigilância da empresa

GET

/v1/vigilancias

curl --request GET \
  --url https://api.cotejar.com.br/v1/vigilancias \
  --header 'Authorization: Bearer <token>'

• Produção

Exige catalogo:ler. Histórico preservado após suspensão. Mais recentes primeiro; siga proximo_cursor até null, com até 100 itens e orçamento de bytes.

Autorizações

• bearerAuth

Parâmetros

Parâmetros de consulta

limite

string

/^(?:[1-9]|[1-9][0-9]|100)$/

cursor

string

>= 1 caractere <= 2048 caracteres

Respostas

200

Response for status 200

Tipo de mídiaapplication/json

object

proximo_cursor

obrigatório

Qualquer um de:

string

string

null

null

itens

obrigatório

Array<object>

object

id

obrigatório

Exemplo sintético; substitua pelo UUID obtido na consulta do seu recurso.

string

/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/

estado

obrigatório

Qualquer um de:

unknown

Qualquer um de:

string

string

Valor permitido: pendente

string

string

Valor permitido: executando

string

string

Valor permitido: concluida

string

string

Valor permitido: falhou

string

string

Valor permitido: concluido

fase

obrigatório

Qualquer um de:

unknown

Qualquer um de:

string

string

Valor permitido: avaliacao

string

string

Valor permitido: publicacao

string

string

Valor permitido: relatorio

null

null

criada_em

obrigatório

string

terminada_em

obrigatório

Qualquer um de:

string

string

null

null

codigo_falha

obrigatório

Qualquer um de:

string

string

null

null

resultado_disponivel

obrigatório

boolean

regulamento_degradado

obrigatório

Qualquer um de:

boolean

boolean

null

null

Exemplo

{
  "itens": [
    {
      "id": "0198d000-0000-7000-8000-000000000001",
      "estado": "concluido",
      "fase": "avaliacao"
    }
  ]
}

401

Response for status 401

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

403

Response for status 403

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

404

Response for status 404

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

422

Response for status 422

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

429

Response for status 429

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

503

Response for status 503

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}