Members API

Hantera teamplatser och roller — personerna som delar ditt kontos utfärdare, märken och utdelningar.

Alla slutpunkter kräver autentisering. Se Autentisering. Varje begäran är begränsad till den autentiserade ägarens konto.

Roller som kan tilldelas via API:et är admin, editor och viewer. Rollen owner är reserverad för kontoinnehavaren och kan inte tilldelas eller tas bort.

Lista medlemmar

Hämta alla medlemmar och väntande inbjudningar på ditt konto.

GET /members

Exempel

curl -X GET https://api.badges.ninja/members \
  -H "X-Api-Key: bws_your_api_key_here"

Svar

{
  "items": [
    {
      "memberId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "email": "owner@acme.example.com",
      "role": "owner",
      "status": "active"
    },
    {
      "memberId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "email": "editor@acme.example.com",
      "role": "editor",
      "status": "pending"
    }
  ]
}

status är active för medlemmar som har accepterat, eller pending för inbjudningar som ännu inte har accepterats.

---

Bjud in medlem

Bjud in en person till kontot via e-post. Ett inbjudningsmeddelande med en acceptlänk skickas till adressen.

POST /members

Parametrar

Parameter	Typ	Obligatorisk	Beskrivning
email	string	Ja	E-postadress att bjuda in (måste vara en giltig e-postadress)
role	string	Ja	Roll att tilldela — en av admin, editor, viewer

Exempel

curl -X POST https://api.badges.ninja/members \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "email": "editor@acme.example.com",
      "role": "editor"
    }
  }'

Svar

{
  "memberId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "inviteId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "status": "pending"
}

Fel

• 400 — role must be one of admin, editor, viewer
• 400 — ogiltig eller saknad e-postadress
• 400 — seat limit reached — kontot har inga lediga platser för planen (Free: 2, Starter: 5, Pro: 20, inklusive ägaren). Ta bort en medlem eller uppgradera planen.
• 400 — e-postadressen är redan medlem eller har en väntande inbjudan på detta konto

---

Acceptera inbjudan

Acceptera en väntande inbjudan. Den autentiserade användarens e-post måste matcha adressen som inbjudan skickades till.

POST /members/accept

Parametrar

Parameter	Typ	Obligatorisk	Beskrivning
inviteId	string	Ja	Inbjudans-ID från e-postmeddelandet med acceptlänken

Exempel

curl -X POST https://api.badges.ninja/members/accept \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "inviteId": "c3d4e5f6-a7b8-9012-cdef-123456789012"
    }
  }'

Svar

{
  "memberId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "status": "active"
}

Fel

• 400 — email does not match invitation — den inloggade e-postadressen skiljer sig från den inbjudna e-postadressen
• 404 — inbjudan hittades inte (redan accepterad, avbruten eller inviteId är felaktigt)

---

Uppdatera medlemsroll

Ändra rollen för en befintlig medlem. Kräver ägar- eller administratörsbehörighet.

POST /members/{memberId}/role

Parametrar

Parameter	Typ	Obligatorisk	Beskrivning
memberId	string	Ja	Medlemmens ID (sökvägsparameter)
role	string	Ja	Ny roll — en av admin, editor, viewer

Exempel

curl -X POST https://api.badges.ninja/members/b2c3d4e5-f6a7-8901-bcde-f12345678901/role \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "role": "admin"
    }
  }'

Svar

{
  "memberId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "role": "admin",
  "updated": true
}

Fel

• 400 — role must be one of admin, editor, viewer
• 400 — the owner role cannot be changed
• 404 — medlemmen hittades inte

---

Ta bort medlem

Ta bort en medlem från kontot, eller avbryt en väntande inbjudan. Medlemmen förlorar omedelbart åtkomsten och deras plats frigörs.

DELETE /members/{memberId}

Exempel

curl -X DELETE https://api.badges.ninja/members/b2c3d4e5-f6a7-8901-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here"

Svar

En ren sträng:

"member has been removed"

Fel

• 400 — the owner cannot be removed
• 404 — medlemmen hittades inte