API

Liste der Benutzer oder einen einzelnen Benutzer abrufen

GET/api/crm/v2/teamv2
operationId: team.default

Ohne id wird eine paginierte Liste von Benutzern mit gekürzten Datensätzen zurückgegeben. Mit id wird der vollständige Benutzerdatensatz in data.list[0] zurückgegeben, ohne Paginierung und Filter. Der Modus (partner oder affiliate) wird vom Server anhand der Sitzung festgelegt. Die Filterung nach Rolle (permission_role_id) und die Suche nach Name (name) sind optional.

Autorisierung

api-token + language + role

Abfrageparameter

idinteger

Wenn übergeben, wird ein vollständiger Eintrag ohne Paginierung zurückgegeben

Beispiel: 1

permission_role_idinteger

Beispiel: 1

namestring

Alle Modi; Teilstring des Benutzernamens (Vor- und Nachname), Groß-/Kleinschreibung wird nicht beachtet

Beispiel: Alina

page_numberinteger

Beispiel: 1

Antworten

OK

object
statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of object
valuestringerforderlich

Beispiel: example

namestringerforderlich

Beispiel: All

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

account_idobject (FilterSelectInteger)
valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object
valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

affiliate_idobject (FilterSelectInteger)
valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object
valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

permission_role_idobject (FilterSelectInteger)
valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object
valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

nameobject (FilterInput)
valuestring

Beispiel: example

typestringerforderlich

Beispiel: integer or string

placeholderstring

Beispiel: string

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

listarray of oneOf
oneOf
Eine der Optionen
object (PermissionRoleUserPartner)

Benutzer im Modus partner

idintegererforderlich

Beispiel: 1

namestring

Beispiel: John Doe

emailstring

Beispiel: user@example.com

photostring

Beispiel: data:image/jpeg;base64,/9j/4AAQSkZJRg...

permission_rolesarray of objecterforderlich

Alle Benutzerrollen, sortiert nach Rollen-id

idintegererforderlich

Beispiel: 5

namestringerforderlich

Rollenname aus dem Rollenverzeichnis; Wertemenge ist offen

Beispiel: head_of_sales

blockedbooleanerforderlich

Status des Sperrschalters

Beispiel: false

phone_format_idinteger (PhoneFormatId)

Ländercode: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Beispiel: 1

phone_numberstring

Beispiel: 9999999999

date_creationstring (DataTimeFormatSQL)

Beispiel: 2024-05-02 08:31:16

bound_settingsarray of string

Benutzerspezifische Einstellungen für Warnungen beim Löschen; null, wenn nicht vorhanden

can_toggle_blockbooleanerforderlich

Der Sperrschalter ist für den aktuellen Benutzer in dieser Zeile verfügbar; die Regel wird vom Server festgelegt, leiten Sie sie nicht aus den Rollennamen ab

Beispiel: true

can_manage_sessionsbooleanerforderlich

Der aktuelle Benutzer kann die Sitzungen dieser Zeile anzeigen und schließen

Beispiel: false

paginationobject (Pagination)
max_countintegererforderlich

Anzahl der Elemente pro Seite

Beispiel: 30

page_numberintegererforderlich

Nummer der aktuellen Seite; begrenzt, sodass der Offset 1000 nicht überschreitet

Beispiel: 1

has_nextbooleanerforderlich

Gibt es eine nächste Seite

Beispiel: true

has_previousbooleanerforderlich

Gibt es eine vorherige Seite

Beispiel: false