Teams

Ein Team ist eine benannte Gruppe von Nutzern in einem Unternehmenskonto. Diese Endpunkte legen Teams an, ändern sie und verwalten, wer dazugehört.

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 Teams eines Unternehmenskontos auf

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

Feldübersicht aus der Spezifikation

Jeder Eintrag enthält:

teamId (string): Id des Teams.
name (string): Name des Teams.
code (string | null): optionaler Team-Code.
isScimGroup (boolean): ob das Team von einem SCIM-Identitätsanbieter synchronisiert wird.
memberCount (number): Anzahl der aktiven Mitglieder.

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: code, isScimGroup, memberCount, name, teamId.
Beispiel: code,isScimGroup

Antwort

teamIdstringPflicht
Id des Teams.
namestringPflicht
Name des Teams.
codestringPflichtkann null sein
Optionaler Team-Code.
isScimGroupbooleanPflicht
Ob das Team von einem SCIM-Identitätsanbieter synchronisiert wird.
memberCountnumberPflicht
Anzahl der aktiven Mitglieder.

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/teams" \
  -H "Authorization: Bearer $SALLY_TOKEN"

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/teams`, {
  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}/teams",
    headers={"Authorization": f"Bearer {os.environ['SALLY_TOKEN']}"},
)
data = response.json()

Beispielantwort 200 OK

[
  {
    "teamId": "3c35d421-a578-4ce7-aebb-c5add21907bd",
    "name": "Sales",
    "code": "string",
    "isScimGroup": true,
    "memberCount": 3
  }
]

Erstellt ein Team

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

Nur Admins/Owner dürfen Teams erstellen.

Feldübersicht aus der Spezifikation

Body-Felder:

name (string, Pflicht): Name des Teams.
code (string, optional): optionaler Team-Code.

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: code, isScimGroup, memberCount, name, teamId.
Beispiel: code,isScimGroup

Request-Body application/json

namestringPflicht
Name des Teams.
codestringoptionalkann null sein
Optionaler Team-Code.

Antwort

teamIdstringPflicht
Id des Teams.
namestringPflicht
Name des Teams.
codestringPflichtkann null sein
Optionaler Team-Code.
isScimGroupbooleanPflicht
Ob das Team von einem SCIM-Identitätsanbieter synchronisiert wird.
memberCountnumberPflicht
Anzahl der aktiven Mitglieder.

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/teams" \
  -H "Authorization: Bearer $SALLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example"
}'

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/teams`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SALLY_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Example"
  }),
});
const data = await response.json();

import os
import requests

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

Beispielantwort 200 OK

{
  "teamId": "3c35d421-a578-4ce7-aebb-c5add21907bd",
  "name": "Sales",
  "code": "string",
  "isScimGroup": true,
  "memberCount": 3
}

Aktualisiert ein Team (Umbenennen + optionaler Code)

PATCH/v1.0/directories/{directoryId}/teams/{teamId}

Nur Admins/Owner.

Feldübersicht aus der Spezifikation

Body-Felder:

name (string, Pflicht): neuer Name des Teams.
code (string, optional): neuer Team-Code; null entfernt ihn, weglassen, um ihn unverändert zu lassen.

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.
teamIdstringPflicht
Id des Teams.

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: code, isScimGroup, memberCount, name, teamId.
Beispiel: code,isScimGroup

Request-Body application/json

namestringPflicht
Neuer Name des Teams.
codestringoptionalkann null sein
Neuer Team-Code; null zum Entfernen, weglassen, um ihn unverändert zu lassen.

Antwort

teamIdstringPflicht
Id des Teams.
namestringPflicht
Name des Teams.
codestringPflichtkann null sein
Optionaler Team-Code.
isScimGroupbooleanPflicht
Ob das Team von einem SCIM-Identitätsanbieter synchronisiert wird.
memberCountnumberPflicht
Anzahl der aktiven Mitglieder.

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 PATCH "https://api.sally.io/v1.0/directories/$DIRECTORY_ID/teams/$TEAM_ID" \
  -H "Authorization: Bearer $SALLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example"
}'

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/teams/${teamId}`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.SALLY_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Example"
  }),
});
const data = await response.json();

import os
import requests

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

Beispielantwort 200 OK

{
  "teamId": "3c35d421-a578-4ce7-aebb-c5add21907bd",
  "name": "Sales",
  "code": "string",
  "isScimGroup": true,
  "memberCount": 3
}

Entfernt (archiviert) ein Team

DELETE/v1.0/directories/{directoryId}/teams/{teamId}

Weiches Löschen (Soft Delete, Archivierung) des Teams und aller seiner Mitgliedschaften. Nur Admins/Owner.

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.
teamIdstringPflicht
Id des Teams.

Statuscodes

204Erfolg
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/teams/$TEAM_ID" \
  -H "Authorization: Bearer $SALLY_TOKEN"

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/teams/${teamId}`, {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.SALLY_TOKEN}`,
  },
});
console.log(response.status); // 204

import os
import requests

response = requests.delete(
    f"https://api.sally.io/v1.0/directories/{directory_id}/teams/{team_id}",
    headers={"Authorization": f"Bearer {os.environ['SALLY_TOKEN']}"},
)
print(response.status_code)  # 204

Beispielantwort 204 No Content

Kein Inhalt. Ein erfolgreicher Aufruf liefert einen leeren Body.

Listet die Mitgliedschaften eines Teams auf

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

Nur die skalaren Werte der Mitgliedschaft (userId, isMainTeam); Nutzerdetails erhältst du über GET .../teams/{teamId}/memberships/users/{userId}.

Feldübersicht aus der Spezifikation

Jeder Eintrag enthält:

teamId (string): Id des Teams.
userId (string): Id des Mitglieds (Nutzers).
isMainTeam (boolean): ob dieses Team das Hauptteam des Nutzers 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.
teamIdstringPflicht
Id des Teams.

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: isMainTeam, teamId, userId.
Beispiel: isMainTeam,teamId

Antwort

teamIdstringPflicht
Id des Teams.
userIdstringPflicht
Id des Mitglieds (Nutzers).
isMainTeambooleanPflicht
Ob dieses Team das Hauptteam des Nutzers ist.

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/teams/$TEAM_ID/memberships" \
  -H "Authorization: Bearer $SALLY_TOKEN"

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/teams/${teamId}/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}/teams/{team_id}/memberships",
    headers={"Authorization": f"Bearer {os.environ['SALLY_TOKEN']}"},
)
data = response.json()

Beispielantwort 200 OK

[
  {
    "teamId": "3c35d421-a578-4ce7-aebb-c5add21907bd",
    "userId": "11f967df-7dd1-4719-a9aa-46530940c443",
    "isMainTeam": true
  }
]

Setzt die Mitglieder eines Teams (vollständiges Ersetzen)

PUT/v1.0/directories/{directoryId}/teams/{teamId}/memberships

Nur Admins/Owner.

Feldübersicht aus der Spezifikation

Body-Felder:

userIds (array of strings, Pflicht): vollständige Ersatzmenge der Nutzer-Ids der Mitglieder. Nutzer, die nicht in der Liste stehen, werden entfernt.

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.
teamIdstringPflicht
Id des Teams.

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: isMainTeam, teamId, userId.
Beispiel: isMainTeam,teamId

Request-Body application/json

userIdsstring[]Pflicht
Vollständige Ersatzmenge der Nutzer-Ids der Mitglieder (vollständiges Ersetzen). Nutzer, die nicht in der Liste stehen, werden entfernt.

Antwort

teamIdstringPflicht
Id des Teams.
userIdstringPflicht
Id des Mitglieds (Nutzers).
isMainTeambooleanPflicht
Ob dieses Team das Hauptteam des Nutzers ist.

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 PUT "https://api.sally.io/v1.0/directories/$DIRECTORY_ID/teams/$TEAM_ID/memberships" \
  -H "Authorization: Bearer $SALLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "userIds": [
    "11f967df-7dd1-4719-a9aa-46530940c443"
  ]
}'

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/teams/${teamId}/memberships`, {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.SALLY_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "userIds": [
      "11f967df-7dd1-4719-a9aa-46530940c443"
    ]
  }),
});
const data = await response.json();

import os
import requests

response = requests.put(
    f"https://api.sally.io/v1.0/directories/{directory_id}/teams/{team_id}/memberships",
    headers={"Authorization": f"Bearer {os.environ['SALLY_TOKEN']}"},
    json={
        "userIds": [
            "11f967df-7dd1-4719-a9aa-46530940c443",
        ],
    },
)
data = response.json()

Beispielantwort 200 OK

[
  {
    "teamId": "3c35d421-a578-4ce7-aebb-c5add21907bd",
    "userId": "11f967df-7dd1-4719-a9aa-46530940c443",
    "isMainTeam": true
  }
]

Listet die Nutzer (Mitglieder) eines Teams auf

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

Feldübersicht aus der Spezifikation

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 dasselbe 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.
teamIdstringPflicht
Id des Teams.

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/teams/$TEAM_ID/memberships/users" \
  -H "Authorization: Bearer $SALLY_TOKEN"

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/teams/${teamId}/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}/teams/{team_id}/memberships/users",
    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"
  }
]

Gibt einen einzelnen Nutzer (Mitglied) eines Teams zurück

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

Der Nutzer muss Mitglied des Teams sein, sonst 404.

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 dasselbe 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.
teamIdstringPflicht
Id des Teams.
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/teams/$TEAM_ID/memberships/users/$USER_ID" \
  -H "Authorization: Bearer $SALLY_TOKEN"

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/teams/${teamId}/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}/teams/{team_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"
}

Listet die Teams eines Unternehmenskontos auf​

Pfadparameter

Query-Parameter

Antwort

Statuscodes

Erstellt ein Team​

Pfadparameter

Query-Parameter

Request-Body application/json

Antwort

Statuscodes

Aktualisiert ein Team (Umbenennen + optionaler Code)​

Pfadparameter

Query-Parameter

Request-Body application/json

Antwort

Statuscodes

Entfernt (archiviert) ein Team​

Pfadparameter

Statuscodes

Listet die Mitgliedschaften eines Teams auf​

Pfadparameter

Query-Parameter

Antwort

Statuscodes

Setzt die Mitglieder eines Teams (vollständiges Ersetzen)​

Pfadparameter

Query-Parameter

Request-Body application/json

Antwort

Statuscodes

Listet die Nutzer (Mitglieder) eines Teams auf​

Pfadparameter

Query-Parameter

Antwort

Statuscodes

Gibt einen einzelnen Nutzer (Mitglied) eines Teams zurück​

Pfadparameter

Query-Parameter

Antwort

Statuscodes

Listet die Teams eines Unternehmenskontos auf

Erstellt ein Team

Aktualisiert ein Team (Umbenennen + optionaler Code)

Entfernt (archiviert) ein Team

Listet die Mitgliedschaften eines Teams auf

Setzt die Mitglieder eines Teams (vollständiges Ersetzen)

Listet die Nutzer (Mitglieder) eines Teams auf

Gibt einen einzelnen Nutzer (Mitglied) eines Teams zurück