Pular para o conteúdo principal

Listar equipamentos da ordem

GEThttps://carchost.fieldcontrol.com.br/orders/{id}/equipments

Lista os equipamentos vinculados a uma ordem de serviço, cada um com as respostas dos campos customizados.

Requer os headers X-Api-Key e User-Agent. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Parâmetros de caminho

idstringobrigatório

Identificador da ordem de serviço.

Exemplo: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

Parâmetros de consulta

limitinteger

Quantidade de itens por página.

De 1 a 100.Padrão: 10.

offsetinteger

Quantidade de itens a pular.

De 0 a 200000.Padrão: 0.

qstring

Filtros no formato campo:valor, separados por espaço (como filtrar). Os filtros aceitos estão na tabela abaixo.

Exemplo: created_at>=:2026-10-01.

FiltroO que faz
equipment_id

Identificador do equipamento.

created_at

Vinculados na data informada (ISO 8601, UTC).

created_at>=

Vinculados a partir da data informada, inclusive.

created_at<=

Vinculados até a data informada, inclusive.

created_at>

Vinculados depois da data informada.

created_at<

Vinculados antes da data informada.

sortstring

Ordenação. Prefixo - inverte a ordem.

Valores aceitos: id, created_at, -created_at.Padrão: id.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Respostas

  • 200

    Lista de equipamentos.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 404

    Recurso não encontrado. O corpo da resposta é vazio.

  • 422

    Identificador inválido ou de outra conta (uriValidationErr).

  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor.