Dokumentasjon

Kortversjonen for deg som vil i gang raskt.

Endepunkt

GET https://api.katalogen.net/v1/search?q=kari%20eksempel

Headers

x-api-key: kat_live_********

Respons

{
  "query": "kari eksempel",
  "page": 1,
  "summary": { "shown": 1, "total": 1 },
  "people": [
    {
      "id": "c5f3b2a1-7c01-4f75-9ad3-2f1a9b2e7d4a",
      "name": "Kari Eksempel",
      "mapUrl": "https://www.openstreetmap.org/...",
      "phones": [{ "number": "+4799990000" }],
      "addresses": [
        {
          "display": "Eksempelveien 12, 0123 Oslo",
          "region": "Oslo",
          "details": {
            "canonical": "Eksempelveien 12",
            "postnummer": "0123",
            "poststed": "Oslo",
            "kommunenavn": "Oslo",
            "kommunenummer": "0301",
            "coordinates": { "lat": 59.9, "lon": 10.7 }
          }
        }
      ]
    }
  ]
}

Feilkoder

401

Ugyldig eller manglende API-nøkkel.

429

Du har nådd grensen for kall.

502

Feil mot upstream-tjenester.