# REST-API

Bas-URL, endpoints, operationer och priser i REST-API:t v1.

Källa: https://getapi.gradientvibe.se/docs/api

Bas-URL: `https://getapi.gradientvibe.se/api/v1`. Alla anrop är GET, tar en nyckel i `Authorization` och svarar med JSON. Versionen står i sökvägen; ändringar som bryter bakåtkompatibiliteten kommer bara i en ny version, se [changelog](https://getapi.gradientvibe.se/docs/changelog).

| Endpoint | Operation | Scope | Pris |
| --- | --- | --- | --- |
| [`GET /api/v1/companies/search`](https://getapi.gradientvibe.se/docs/api/sok-bolag) | `search_companies` | `companies:read` | Gratis |
| [`GET /api/v1/companies/{org_number}`](https://getapi.gradientvibe.se/docs/api/bolag) | `get_company` | `companies:read` | 0,05 kr |
| [`GET /api/v1/companies/{org_number}`](https://getapi.gradientvibe.se/docs/api/bolag) | `get_company_full` | `companies:read` | 0,10 kr |
| [`GET /api/v1/companies/{org_number}/roles`](https://getapi.gradientvibe.se/docs/api/roller) | `get_company_roles` | `roles:read` | 0,10 kr |
| [`GET /api/v1/companies/{org_number}/history`](https://getapi.gradientvibe.se/docs/api/historik) | `get_company_history` | `history:read` | 0,50 kr |
| [`GET /api/v1/companies/{org_number}/financials`](https://getapi.gradientvibe.se/docs/api/bokslut) | `get_financials` | `financials:read` | 0,10 kr |
| [`GET /api/v1/persons/{person_ref}/engagements`](https://getapi.gradientvibe.se/docs/api/engagemang) | `get_person_engagements` | `persons:read` | 0,10 kr |
| [`GET /api/v1/account`](https://getapi.gradientvibe.se/docs/api/konto) | – | – | Gratis |

## Gemensamt för alla anrop

- Svaret är `{ "status": "ok", "data", "meta" }` eller `{ "status": "error", "error": { "code", "message" } }`. Se [svarsformat](https://getapi.gradientvibe.se/docs/svarsformat) och [felkoder](https://getapi.gradientvibe.se/docs/fel).
- Organisationsnummer tas emot med eller utan bindestreck och returneras som `NNNNNN-NNNN`.
- Skicka `Idempotency-Key` när du försöker igen efter ett nätverksfel, så debiteras samma uppslag inte två gånger. Se [takt och tak](https://getapi.gradientvibe.se/docs/takt-och-tak#idempotency-key).
- Svaren cachas inte (`Cache-Control: no-store`).
- OpenAPI 3: [https://getapi.gradientvibe.se/openapi.json](https://getapi.gradientvibe.se/openapi.json).

## Endpoints

- [Sök bolag](https://getapi.gradientvibe.se/docs/api/sok-bolag): Hitta bolag på namn eller organisationsnummer. Högst tio träffar. Gratis, upp till 1 000 sökningar per dygn.
- [Hämta bolag](https://getapi.gradientvibe.se/docs/api/bolag): Bolagsprofil: namn, form, status, säte och bransch. Med detail=full även adresser, F-skatt, moms, verksamhet, tidigare namn och aktiekapital.
- [Styrelse och roller](https://getapi.gradientvibe.se/docs/api/roller): Styrelse, VD, suppleanter och revisor med person_ref, och bolagets firmateckning.
- [Historik och ändringar](https://getapi.gradientvibe.se/docs/api/historik): Registrerade ändringar (styrelse, adress, årsredovisning med mera) sedan ett datum, och bolagets statushistorik.
- [Bokslut och nyckeltal](https://getapi.gradientvibe.se/docs/api/bokslut): Resultat- och balansräkning i tusental kronor och nyckeltal för upp till fem år. Bara aktiebolag.
- [Personers engagemang](https://getapi.gradientvibe.se/docs/api/engagemang): Alla bolag där en person har eller har haft ett uppdrag. Personen anges med person_ref från ett rollsvar.
- [Konto och saldo](https://getapi.gradientvibe.se/docs/api/konto): Ditt konto, saldot, månadens förbrukning och nyckelns scopes och miljö. Gratis och mäts inte.