Rollen

Eine Rolle bestimmt, was ein Mitglied in einem Unternehmenskonto darf. Diese Liste löst die roleId auf, die du an Mitgliedschaften und Einladungen findest.

Jeder Endpunkt unten zeigt in der Mitte seine Parameter und Antwortfelder und rechts ein Anfragebeispiel mit Beispielantwort.

Basis-URL https://api.sally.ioVersion v1.0 aktuell, noch nicht eingefrorenSo funktioniert die Versionierung

Listet die Rollen auf, die eine Mitgliedschaft haben kann (löst `roleId` auf)

GET/v1.0/roles

Feldübersicht aus der Spezifikation

Jeder Eintrag enthält:

• roleId (string): Id der Rolle.
• name (string): Name der Rolle; einer von Owner, Admin, Member.

Query-Parameter

• fieldsstringoptional

  Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

  Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

  Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

  Hier auswählbar: name, roleId.

  Beispiel: name,roleId

Antwort

• roleIdstringPflicht

  Id der Rolle.

• namestringPflicht

  Name der Rolle.

  Erlaubte Werte: OwnerAdminMember

Statuscodes

• 200Erfolg
• 401

  Fehlender oder ungültiger Bearer-Token.

• 429

  Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

• 500

  Interner Serverfehler.

Anfrage

cURL

curl "https://api.sally.io/v1.0/roles" \
  -H "Authorization: Bearer $SALLY_TOKEN"

JavaScript

const response = await fetch(`https://api.sally.io/v1.0/roles`, {
  headers: {
    Authorization: `Bearer ${process.env.SALLY_TOKEN}`,
  },
});
const data = await response.json();

Python

import os
import requests

response = requests.get(
    f"https://api.sally.io/v1.0/roles",
    headers={"Authorization": f"Bearer {os.environ['SALLY_TOKEN']}"},
)
data = response.json()

Beispielantwort 200 OK

[
  {
    "roleId": "164531fc-9be4-4de4-a183-89cc85d6a98c",
    "name": "Owner"
  }
]