Unternehmenskonten und Mitglieder

Ein Directory ist ein Sally-Unternehmenskonto. Diese Endpunkte liefern Unternehmenskonten, ihre Mitgliedschaften und Nutzer und erlauben Admins, Mitglieder einzuladen und zu entfernen.

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 Unternehmenskonten auf, in denen der authentifizierte Nutzer Mitglied ist

GET/v1.0/directories

Discovery-Endpunkt: gibt alle Unternehmenskonten des Token-Nutzers zurück (aktive, nicht gesperrte Mitgliedschaften). Die directoryId wird in den nachfolgenden Pfaden verwendet. Jeder Eintrag enthält dieselben Felder wie der Endpunkt für ein einzelnes Unternehmenskonto.

Feldübersicht aus der Spezifikation

Felder der Antwort (pro Unternehmenskonto):

directoryId (string): Id des Unternehmenskontos; verwende sie in allen /v1.0/directories/{directoryId}/...-Pfaden.
name (string): Anzeigename des Unternehmenskontos.
pictureFileUrl (string | null): absolute URL des Logos des Unternehmenskontos (erfordert denselben Bearer-Token wie die API); null, wenn nicht gesetzt.
languageCode (string | null): Standardsprache des Unternehmenskontos (IETF-Sprach-Tag, z. B. de-DE, en); null, wenn nicht gesetzt.
maxApiRequestsPerMinute (number): maximale Anzahl an API-Anfragen pro Minute, die für dieses Unternehmenskonto erlaubt sind.
maxApiRequestsPerDay (number): maximale Anzahl an API-Anfragen pro Tag, die für dieses Unternehmenskonto erlaubt sind.

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: directoryId, languageCode, maxApiRequestsPerDay, maxApiRequestsPerMinute, name, pictureFileUrl.
Beispiel: directoryId,languageCode

Antwort

directoryIdstringPflicht
Eindeutige Id des Unternehmenskontos.
namestringPflicht
Anzeigename des Unternehmenskontos.
pictureFileUrlstringPflichtkann null sein
Absolute URL des Logos des Unternehmenskontos oder null. Erfordert denselben Bearer-Token wie die API.
languageCodestringPflichtkann null sein
Standardsprache des Unternehmenskontos (IETF-Sprach-Tag, z. B. de-DE, en-US).
maxApiRequestsPerMinutenumberPflicht
Maximale Anzahl an API-Anfragen pro Minute, die für dieses Unternehmenskonto erlaubt sind.
maxApiRequestsPerDaynumberPflicht
Maximale Anzahl an API-Anfragen pro Tag, die für dieses Unternehmenskonto erlaubt sind.

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
JavaScript
Python

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

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

import os
import requests

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

Beispielantwort 200 OK

[
  {
    "directoryId": "5daeda15-8fc7-4693-a1e1-13119cceb461",
    "name": "Example GmbH",
    "pictureFileUrl": "https://example.com/hooks/sally",
    "languageCode": "de-DE",
    "maxApiRequestsPerMinute": 60,
    "maxApiRequestsPerDay": 10000
  }
]

Gibt ein einzelnes Unternehmenskonto zurück (wenn der Nutzer Mitglied ist)

GET/v1.0/directories/{directoryId}

Gibt ein Unternehmenskonto anhand seiner Id zurück (der Aufrufer muss Mitglied sein, sonst 404). Gleiche Struktur wie die Discovery-Liste.

Feldübersicht aus der Spezifikation

Felder der Antwort:

directoryId (string): Id des Unternehmenskontos; verwende sie in allen /v1.0/directories/{directoryId}/...-Pfaden.
name (string): Anzeigename des Unternehmenskontos.
pictureFileUrl (string | null): absolute URL des Logos des Unternehmenskontos (erfordert denselben Bearer-Token wie die API); null, wenn nicht gesetzt.
languageCode (string | null): Standardsprache des Unternehmenskontos (IETF-Sprach-Tag, z. B. de-DE, en); null, wenn nicht gesetzt.
maxApiRequestsPerMinute (number): maximale Anzahl an API-Anfragen pro Minute, die für dieses Unternehmenskonto erlaubt sind.
maxApiRequestsPerDay (number): maximale Anzahl an API-Anfragen pro Tag, die für dieses Unternehmenskonto erlaubt sind.

Pfadparameter

directoryIdstringPflicht
Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

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: directoryId, languageCode, maxApiRequestsPerDay, maxApiRequestsPerMinute, name, pictureFileUrl.
Beispiel: directoryId,languageCode

Antwort

directoryIdstringPflicht
Eindeutige Id des Unternehmenskontos.
namestringPflicht
Anzeigename des Unternehmenskontos.
pictureFileUrlstringPflichtkann null sein
Absolute URL des Logos des Unternehmenskontos oder null. Erfordert denselben Bearer-Token wie die API.
languageCodestringPflichtkann null sein
Standardsprache des Unternehmenskontos (IETF-Sprach-Tag, z. B. de-DE, en-US).
maxApiRequestsPerMinutenumberPflicht
Maximale Anzahl an API-Anfragen pro Minute, die für dieses Unternehmenskonto erlaubt sind.
maxApiRequestsPerDaynumberPflicht
Maximale Anzahl an API-Anfragen pro Tag, die für dieses Unternehmenskonto erlaubt sind.

Statuscodes

200Erfolg
400
Ungültige Anfrage (Validierungsfehler).
401
Fehlender oder ungültiger Bearer-Token.
404
Ressource nicht gefunden oder nicht zugänglich.
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
JavaScript
Python

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

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

import os
import requests

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

Beispielantwort 200 OK

{
  "directoryId": "5daeda15-8fc7-4693-a1e1-13119cceb461",
  "name": "Example GmbH",
  "pictureFileUrl": "https://example.com/hooks/sally",
  "languageCode": "de-DE",
  "maxApiRequestsPerMinute": 60,
  "maxApiRequestsPerDay": 10000
}

Listet die Mitgliedschaften eines Unternehmenskontos auf (paginiert, optional gefiltert)

GET/v1.0/directories/{directoryId}/memberships

Paginierung über ?page + ?pageSize (max. 100). Ein optionaler ?search-Teilstring durchsucht Vorname, Nachname und E-Mail des Mitglieds (ohne Beachtung der Groß- und Kleinschreibung). Gibt nur die skalaren Werte der Mitgliedschaft zurück (userId, roleId, licenseId, isBlocked); Nutzerdetails holst du über GET .../memberships/users/{userId}. Löse roleId/licenseId über GET /v1.0/roles / GET /v1.0/licenses auf.

Feldübersicht aus der Spezifikation

Felder der Antwort:

page / pageSize / total / hasMore: Paginierungs-Hülle (aktuelle Seite, Seitengröße, Gesamtzahl, ob weitere Seiten folgen).
items (array): die Mitgliedschaften auf dieser Seite. Jeder Eintrag enthält:
- directoryId (string): Id des Unternehmenskontos, zu dem diese Mitgliedschaft gehört.
- userId (string): Id des Nutzers, zu dem diese Mitgliedschaft gehört.
- roleId (string): Rollen-Id des Nutzers in diesem Unternehmenskonto; auflösen über GET /v1.0/roles.
- licenseId (string): Lizenz-Id des Nutzers in diesem Unternehmenskonto; auflösen über GET /v1.0/licenses.
- isBlocked (boolean): ob der Nutzer in diesem Unternehmenskonto gesperrt ist.

Pfadparameter

directoryIdstringPflicht
Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

Query-Parameter

pagenumberoptional
Seitennummer, beginnend bei 1. Standard: 1.
pageSizenumberoptional
Einträge pro Seite. Standard: 25, maximal 100.
searchstringoptional
Teilstring-Suche ohne Beachtung der Groß- und Kleinschreibung in Vorname, Nachname und E-Mail. Der Suchbegriff kann am Anfang, in der Mitte oder am Ende stehen.
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: directoryId, isBlocked, licenseId, roleId, userId.
Beispiel: directoryId,isBlocked

Antwort: je Eintrag in items

directoryIdstringPflicht
Id des Unternehmenskontos, zu dem diese Mitgliedschaft gehört.
userIdstringPflicht
Id des Nutzers, zu dem diese Mitgliedschaft gehört.
roleIdstringPflicht
Rollen-Id des Nutzers in diesem Unternehmenskonto. Auflösen über GET /v1.0/roles.
licenseIdstringPflicht
Lizenz-Id des Nutzers in diesem Unternehmenskonto. Auflösen über GET /v1.0/licenses.
isBlockedbooleanPflicht
Ob der Nutzer in diesem Unternehmenskonto gesperrt ist.

Jede Seite trägt außerdem page, pageSize, total, hasMore.

Statuscodes

200Erfolg
400
Ungültige Anfrage (Validierungsfehler).
401
Fehlender oder ungültiger Bearer-Token.
404
Ressource nicht gefunden oder nicht zugänglich.
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
JavaScript
Python

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

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

import os
import requests

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

Beispielantwort 200 OK

{
  "page": 1,
  "pageSize": 25,
  "total": 137,
  "hasMore": true,
  "items": [
    {
      "directoryId": "5daeda15-8fc7-4693-a1e1-13119cceb461",
      "userId": "11f967df-7dd1-4719-a9aa-46530940c443",
      "roleId": "164531fc-9be4-4de4-a183-89cc85d6a98c",
      "licenseId": "f5f084e9-b993-425f-ad36-bfd5dc3f0e65",
      "isBlocked": true
    }
  ]
}

Lädt einen Nutzer in das Unternehmenskonto ein bzw. legt ihn an

POST/v1.0/directories/{directoryId}/memberships

Legt eine Mitgliedschaft an, indem ein Nutzer (per E-Mail) mit einer Rolle und einer Lizenz eingeladen wird. Nur Admins/Owner dürfen einladen; nur ein Owner darf einen weiteren Owner einladen. Schlägt mit 400 fehl, wenn kein freier Lizenzplatz verfügbar ist.

Feldübersicht aus der Spezifikation

Felder im Body:

email (string, Pflicht): einzuladende E-Mail-Adresse.
roleId (string, Pflicht): zuzuweisende Rollen-Id; gültige Ids erhältst du über GET /v1.0/roles.
licenseId (string, Pflicht): zuzuweisende Lizenz-Id; gültige Ids erhältst du über GET /v1.0/licenses.
description (string, optional): Freitext-Notiz.
languageCode (string, optional): Sprache der Einladung (IETF-Sprach-Tag, z. B. de-DE).

Pfadparameter

directoryIdstringPflicht
Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

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: createdOn, inviteeEmail, licenseId, roleId, userId.
Beispiel: createdOn,inviteeEmail

Request-Body application/json

emailstringPflicht
Einzuladende E-Mail-Adresse.
roleIdstringPflicht
Zuzuweisende Rollen-Id. Gültige Ids erhältst du über GET /v1.0/roles.
licenseIdstringPflicht
Zuzuweisende Lizenz-Id. Gültige Ids erhältst du über GET /v1.0/licenses.
descriptionstringoptionalkann null sein
Optionale Notiz.
languageCodestringoptionalkann null sein
Optionale Sprache der Einladung als IETF-Sprach-Tag (z. B. de-DE).

Antwort

userIdstringPflicht
Id des eingeladenen Nutzers.
inviteeEmailstringPflichtkann null sein
Eingeladene E-Mail-Adresse.
roleIdstringPflicht
Zugewiesene Rollen-Id.
licenseIdstringPflicht
Zugewiesene Lizenz-Id.
createdOnstringPflicht
Zeitstempel der Erstellung (ISO-8601).

Statuscodes

200Erfolg
400
Ungültige Anfrage (Validierungsfehler).
401
Fehlender oder ungültiger Bearer-Token.
403
Verboten (unzureichende Berechtigungen).
404
Ressource nicht gefunden oder nicht zugänglich.
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
JavaScript
Python

curl -X POST "https://api.sally.io/v1.0/directories/$DIRECTORY_ID/memberships" \
  -H "Authorization: Bearer $SALLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "anna.berger@example.com",
  "roleId": "164531fc-9be4-4de4-a183-89cc85d6a98c",
  "licenseId": "f5f084e9-b993-425f-ad36-bfd5dc3f0e65"
}'

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/memberships`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SALLY_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "email": "anna.berger@example.com",
    "roleId": "164531fc-9be4-4de4-a183-89cc85d6a98c",
    "licenseId": "f5f084e9-b993-425f-ad36-bfd5dc3f0e65"
  }),
});
const data = await response.json();

import os
import requests

response = requests.post(
    f"https://api.sally.io/v1.0/directories/{directory_id}/memberships",
    headers={"Authorization": f"Bearer {os.environ['SALLY_TOKEN']}"},
    json={
        "email": "anna.berger@example.com",
        "roleId": "164531fc-9be4-4de4-a183-89cc85d6a98c",
        "licenseId": "f5f084e9-b993-425f-ad36-bfd5dc3f0e65",
    },
)
data = response.json()

Beispielantwort 200 OK

{
  "userId": "11f967df-7dd1-4719-a9aa-46530940c443",
  "inviteeEmail": "anna.berger@example.com",
  "roleId": "164531fc-9be4-4de4-a183-89cc85d6a98c",
  "licenseId": "f5f084e9-b993-425f-ad36-bfd5dc3f0e65",
  "createdOn": "2026-09-24T09:30:00Z"
}

Listet die Nutzer eines Unternehmenskontos auf (paginiert, optional gefiltert)

GET/v1.0/directories/{directoryId}/memberships/users

Basisinformationen aller Mitglieder des Unternehmenskontos. Paginierung über ?page + ?pageSize (max. 100). Ein optionaler ?search-Teilstring durchsucht Vorname, Nachname und E-Mail (ohne Beachtung der Groß- und Kleinschreibung). Der Aufrufer muss Mitglied des Unternehmenskontos sein.

Feldübersicht aus der Spezifikation

Felder der Antwort:

page / pageSize / total / hasMore: Paginierungs-Hülle (aktuelle Seite, Seitengröße, Gesamtzahl, ob weitere Seiten folgen).
items (array): die Nutzer auf dieser Seite. Jeder Eintrag enthält:
- userId (string): Id des Nutzers.
- email (string): E-Mail-Adresse des Nutzers.
- firstName (string): Vorname.
- lastName (string): Nachname.
- pictureFileUrl (string | null): absolute URL des Profilbilds oder null. Erfordert denselben Bearer-Token wie die API.

Pfadparameter

directoryIdstringPflicht
Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

Query-Parameter

pagenumberoptional
Seitennummer, beginnend bei 1. Standard: 1.
pageSizenumberoptional
Einträge pro Seite. Standard: 25, maximal 100.
searchstringoptional
Teilstring-Suche ohne Beachtung der Groß- und Kleinschreibung in Vorname, Nachname und E-Mail. Der Suchbegriff kann am Anfang, in der Mitte oder am Ende stehen.
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: email, firstName, lastName, pictureFileUrl, userId.
Beispiel: email,firstName

Antwort: je Eintrag in items

userIdstringPflicht
Id des Nutzers.
emailstringPflicht
E-Mail-Adresse des Nutzers.
firstNamestringPflicht
Vorname.
lastNamestringPflicht
Nachname.
pictureFileUrlstringPflichtkann null sein
Absolute URL des Profilbilds oder null. Erfordert denselben Bearer-Token wie die API.

Jede Seite trägt außerdem page, pageSize, total, hasMore.

Statuscodes

200Erfolg
400
Ungültige Anfrage (Validierungsfehler).
401
Fehlender oder ungültiger Bearer-Token.
404
Ressource nicht gefunden oder nicht zugänglich.
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
JavaScript
Python

curl "https://api.sally.io/v1.0/directories/$DIRECTORY_ID/memberships/users" \
  -H "Authorization: Bearer $SALLY_TOKEN"

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

import os
import requests

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

Beispielantwort 200 OK

{
  "page": 1,
  "pageSize": 25,
  "total": 137,
  "hasMore": true,
  "items": [
    {
      "userId": "11f967df-7dd1-4719-a9aa-46530940c443",
      "email": "anna.berger@example.com",
      "firstName": "Anna",
      "lastName": "Berger",
      "pictureFileUrl": "https://example.com/hooks/sally"
    }
  ]
}

Durchsucht die Nutzer eines Unternehmenskontos (Parameter im Body)

POST/v1.0/directories/{directoryId}/memberships/users/search

Der Aufrufer muss Mitglied des Unternehmenskontos sein.

Feldübersicht aus der Spezifikation

Felder im Body:

search (string, optional): Teilstring ohne Beachtung der Groß- und Kleinschreibung in Vorname, Nachname und E-Mail; der Suchbegriff kann am Anfang, in der Mitte oder am Ende stehen.
page (number, optional, Standard 1): Seitennummer, beginnend bei 1.
pageSize (number, optional, Standard 25): Seitengröße (max. 100).

Pfadparameter

directoryIdstringPflicht
Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

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: email, firstName, lastName, pictureFileUrl, userId.
Beispiel: email,firstName

Request-Body application/json

searchstringoptionalkann null sein
Teilstring-Suche ohne Beachtung der Groß- und Kleinschreibung in Vorname, Nachname und E-Mail. Der Suchbegriff kann am Anfang, in der Mitte oder am Ende stehen.
pagenumberoptional
Seite (beginnend bei 1, Standard 1).
pageSizenumberoptional
Seitengröße (Standard 25, max. 100).

Antwort: je Eintrag in items

userIdstringPflicht
Id des Nutzers.
emailstringPflicht
E-Mail-Adresse des Nutzers.
firstNamestringPflicht
Vorname.
lastNamestringPflicht
Nachname.
pictureFileUrlstringPflichtkann null sein
Absolute URL des Profilbilds oder null. Erfordert denselben Bearer-Token wie die API.

Jede Seite trägt außerdem page, pageSize, total, hasMore.

Statuscodes

200Erfolg
400
Ungültige Anfrage (Validierungsfehler).
401
Fehlender oder ungültiger Bearer-Token.
403
Verboten (unzureichende Berechtigungen).
404
Ressource nicht gefunden oder nicht zugänglich.
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
JavaScript
Python

curl -X POST "https://api.sally.io/v1.0/directories/$DIRECTORY_ID/memberships/users/search" \
  -H "Authorization: Bearer $SALLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "search": "pricing",
  "page": 1,
  "pageSize": 25
}'

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/memberships/users/search`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SALLY_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "search": "pricing",
    "page": 1,
    "pageSize": 25
  }),
});
const data = await response.json();

import os
import requests

response = requests.post(
    f"https://api.sally.io/v1.0/directories/{directory_id}/memberships/users/search",
    headers={"Authorization": f"Bearer {os.environ['SALLY_TOKEN']}"},
    json={
        "search": "pricing",
        "page": 1,
        "pageSize": 25,
    },
)
data = response.json()

Beispielantwort 200 OK

{
  "page": 1,
  "pageSize": 25,
  "total": 137,
  "hasMore": true,
  "items": [
    {
      "userId": "11f967df-7dd1-4719-a9aa-46530940c443",
      "email": "anna.berger@example.com",
      "firstName": "Anna",
      "lastName": "Berger",
      "pictureFileUrl": "https://example.com/hooks/sally"
    }
  ]
}

Gibt einen einzelnen Nutzer eines Unternehmenskontos zurück

GET/v1.0/directories/{directoryId}/memberships/users/{userId}

Basisinformationen eines Nutzers anhand seiner Id. Der Aufrufer muss Mitglied des Unternehmenskontos sein, und der angefragte Nutzer muss Mitglied desselben Unternehmenskontos sein, sonst 404 (es wird nicht verraten, ob der Nutzer existiert).

Feldübersicht aus der Spezifikation

Felder der Antwort:

userId (string): Id des Nutzers.
email (string): E-Mail-Adresse des Nutzers.
firstName (string): Vorname.
lastName (string): Nachname.
pictureFileUrl (string | null): absolute URL des Profilbilds oder null. Erfordert denselben Bearer-Token wie die API.

Pfadparameter

directoryIdstringPflicht
Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.
userIdstringPflicht
Id des Nutzers.

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: email, firstName, lastName, pictureFileUrl, userId.
Beispiel: email,firstName

Antwort

userIdstringPflicht
Id des Nutzers.
emailstringPflicht
E-Mail-Adresse des Nutzers.
firstNamestringPflicht
Vorname.
lastNamestringPflicht
Nachname.
pictureFileUrlstringPflichtkann null sein
Absolute URL des Profilbilds oder null. Erfordert denselben Bearer-Token wie die API.

Statuscodes

200Erfolg
400
Ungültige Anfrage (Validierungsfehler).
401
Fehlender oder ungültiger Bearer-Token.
404
Ressource nicht gefunden oder nicht zugänglich.
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
JavaScript
Python

curl "https://api.sally.io/v1.0/directories/$DIRECTORY_ID/memberships/users/$USER_ID" \
  -H "Authorization: Bearer $SALLY_TOKEN"

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

import os
import requests

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

Beispielantwort 200 OK

{
  "userId": "11f967df-7dd1-4719-a9aa-46530940c443",
  "email": "anna.berger@example.com",
  "firstName": "Anna",
  "lastName": "Berger",
  "pictureFileUrl": "https://example.com/hooks/sally"
}

Entfernt einen Nutzer aus dem Unternehmenskonto

DELETE/v1.0/directories/{directoryId}/memberships/{userId}

Widerruft die Mitgliedschaft des Nutzers. Nur Admins/Owner dürfen Mitglieder entfernen; der letzte Owner kann nicht entfernt werden. War es das letzte Unternehmenskonto des Nutzers, wird der Nutzer vollständig gelöscht (DSGVO).

Pfadparameter

directoryIdstringPflicht
Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.
userIdstringPflicht
Id des Nutzers.

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: userHardDeleted.
Beispiel: userHardDeleted

Antwort

userHardDeletedbooleanPflicht
True, wenn der Nutzer keine weiteren Unternehmenskonten hatte und deshalb vollständig gelöscht wurde (DSGVO).

Statuscodes

200Erfolg
400
Ungültige Anfrage (Validierungsfehler).
401
Fehlender oder ungültiger Bearer-Token.
403
Verboten (unzureichende Berechtigungen).
404
Ressource nicht gefunden oder nicht zugänglich.
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
JavaScript
Python

curl -X DELETE "https://api.sally.io/v1.0/directories/$DIRECTORY_ID/memberships/$USER_ID" \
  -H "Authorization: Bearer $SALLY_TOKEN"

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/memberships/${userId}`, {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.SALLY_TOKEN}`,
  },
});
const data = await response.json();

import os
import requests

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

Beispielantwort 200 OK

{
  "userHardDeleted": true
}

Listet die Unternehmenskonten auf, in denen der authentifizierte Nutzer Mitglied ist​

Query-Parameter

Antwort

Statuscodes

Gibt ein einzelnes Unternehmenskonto zurück (wenn der Nutzer Mitglied ist)​

Pfadparameter

Query-Parameter

Antwort

Statuscodes

Listet die Mitgliedschaften eines Unternehmenskontos auf (paginiert, optional gefiltert)​

Pfadparameter

Query-Parameter

Antwort: je Eintrag in items

Statuscodes

Lädt einen Nutzer in das Unternehmenskonto ein bzw. legt ihn an​

Pfadparameter

Query-Parameter

Request-Body application/json

Antwort

Statuscodes

Listet die Nutzer eines Unternehmenskontos auf (paginiert, optional gefiltert)​

Pfadparameter

Query-Parameter

Antwort: je Eintrag in items

Statuscodes

Durchsucht die Nutzer eines Unternehmenskontos (Parameter im Body)​

Pfadparameter

Query-Parameter

Request-Body application/json

Antwort: je Eintrag in items

Statuscodes

Gibt einen einzelnen Nutzer eines Unternehmenskontos zurück​

Pfadparameter

Query-Parameter

Antwort

Statuscodes

Entfernt einen Nutzer aus dem Unternehmenskonto​

Pfadparameter

Query-Parameter

Antwort

Statuscodes

Listet die Unternehmenskonten auf, in denen der authentifizierte Nutzer Mitglied ist

Gibt ein einzelnes Unternehmenskonto zurück (wenn der Nutzer Mitglied ist)

Listet die Mitgliedschaften eines Unternehmenskontos auf (paginiert, optional gefiltert)

Lädt einen Nutzer in das Unternehmenskonto ein bzw. legt ihn an

Listet die Nutzer eines Unternehmenskontos auf (paginiert, optional gefiltert)

Durchsucht die Nutzer eines Unternehmenskontos (Parameter im Body)

Gibt einen einzelnen Nutzer eines Unternehmenskontos zurück

Entfernt einen Nutzer aus dem Unternehmenskonto