REST-API

Personers engagemang

Alla bolag där en person har eller har haft ett uppdrag. Personen anges med person_ref från ett rollsvar.

http

GET /api/v1/persons/{person_ref}/engagements

Operation	Scope	Pris per uppslag
`get_person_engagements` (personers engagemang)	`persons:read`	0,10 kr

Parametrar#

Namn	Var	Typ	Standard	Beskrivning
`person_ref` (krävs)	path	string	–	Handtaget `pr_…` från ett svar på roller. Det är bundet till ditt konto.
`include_former`	query	boolean	`false`	`true` tar med avslutade uppdrag.

Headers: Authorization: Bearer … (krävs) och Idempotency-Key (valfri).

Exempel#

Exemplen saknas just nu

Svaren från sandlådan kunde inte genereras i den här miljön. Anropen fungerar som beskrivet.

Engagemang, även tidigare#

curl -s "http://localhost:3020/api/v1/persons/$PERSON_REF/engagements?include_former=true" \
  -H "Authorization: Bearer $GETBOLAG_KEY"

Exemplet kunde inte genereras i den här miljön.

Okänd person_ref#

bash

curl -s "http://localhost:3020/api/v1/persons/pr_finnsinte/engagements" \
  -H "Authorization: Bearer $GETBOLAG_KEY"

Exemplet kunde inte genereras i den här miljön.

Om svaret#

Engagemangen är personens uppdrag i alla bolag, med roll och datum.
En enskild firmas organisationsnummer är innehavarens personnummer. Därför är company.org_number null och org_number_withheld true för enskilda firmor i den här listan.
En person_ref från ett annat konto, eller ett påhittat värde, ger 400 invalid_person_ref.
Varje person räknas mot taket för antal olika bolag och personer per dygn, se takt och tak.

Felkoder#

Kod	HTTP	Vad du gör
`invalid_person_ref`	400	Hämta personens person_ref på nytt via bolagets roller.
`invalid_parameter`	400	Kontrollera parametrarna mot endpointens tabell. Okända parametrar avvisas i stället för att ignoreras.
`entity_cap_exceeded`	429	Bolag och personer du redan hämtat i dag går att hämta igen. Behöver du ett högre tak, kontakta support.
`unauthorized`	401	Skicka `Authorization: Bearer gb_test_…` eller `gb_live_…`. Kontrollera att hela nyckeln kom med. En OAuth-token gäller en timme; förnya den med refresh-token.
`insufficient_scope`	403	Skapa en nyckel med rätt scope under Konto → Nycklar. Se scopes.
`email_not_verified`	403	Klicka på länken i bekräftelsemejlet, eller skicka ett nytt från Konto.
`user_disabled`	403	Be kontots ägare att aktivera användaren, eller använd en egen nyckel.
`account_not_active`	403	Använd en testnyckel tills kontot är godkänt. Status syns under Konto.
`blocked_by_phase`	503	Använd en testnyckel mot sandlådan. Vi meddelar när live-data öppnar. Se sandlådan.
`suspended`	503	Kontakta support@getbolag.se.
`rate_limited`	429	Vänta så många sekunder som `Retry-After` anger och försök igen. Se takt och tak.
`insufficient_credits`	402	Fyll på under Konto → Krediter.
`monthly_cap_reached`	402	Höj taket under Konto, eller vänta till nästa månad.
`key_daily_cap_reached`	402	Höj nyckelns tak under Konto → Nycklar, eller vänta till nästa dygn.
`invalid_idempotency_key`	400	Skicka ett kort, unikt värde per uppslag, till exempel ett UUID.
`idempotency_key_reused`	422	Använd en ny nyckel för varje nytt uppslag. Samma nyckel gäller bara när exakt samma anrop görs om. Se Idempotency-Key.
`internal_error`	500	Försök igen med samma `Idempotency-Key`. Ange `request_id` om du kontaktar support.

Samma uppslag i MCP: verktyget gb_get_person_engagements. Se MCP.