MDSAPI Portal/IZII MDS — Orquestrador de Benefícios (REST)
get

Listar locais de atendimento

/v1/locais

Retorna locais de atendimento / rede credenciada de uma operadora.

Query Parameters

ufstring

UF para filtrar locais.

municipiostring

Município para filtrar.

paginainteger

Página (paginação). Inicia em 1.

quantidadePorPaginainteger

Quantidade de itens por página.

Headers

X-Cnpj-Provedorstringrequired

CNPJ da operadora de destino — atua como **chave de roteamento** (padrão Mediator). Ex.: SulAmérica `01685053000156`.

Responses

200

Lista de locais de atendimento.

object
dataarray

items

object
paginacaoobject
paginainteger
quantidadePorPaginainteger
totalinteger
totalPaginasinteger
Ver schema bruto / exemplo JSON
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "paginacao": {
      "$ref": "#/components/schemas/Paginacao"
    }
  }
}
401

Token ausente, expirado ou inválido.

object

Estrutura padronizada de erro.

statusinteger

Código HTTP do erro.

codigostring

Código interno do erro.

mensagemstring

Descrição legível do erro.

criticasarray

items

object

Crítica/erro de validação devolvido pela operadora.

codigostring
campostring
mensagemstring