Nutzer in CentralStationCRM

API Navigation

Allgemeines: Grundlagen Authentifizierung Fehlerbehandlung Datenstruktur

Hauptmodelle: Personen Firmen Angebote Projekte Aufgaben

Sonstiges: Anschriften Kontaktdaten Wichtige Daten Individuelle Felder Positionen Notizen Dateianhänge Tags

Die Kür: Webhooks Nutzer Aktivitäten Filter Gruppen Individuelle Feld Typen

Bei den Nutzern in CentralStationCRM stehen die Actions index und search zur Verfügung. Jeder Nutzer enthält die folgenden Felder:

Feldname Feldtyp Beschreibung
id INTEGER ID des Nutzers (Read only)
first VARCHAR(60) Vorname des Nutzers (Pflichtfeld)
name VARCHAR(60) Nachname des Nutzers (Pflichtfeld)
login VARCHAR(100) E-Mail Adresse und Login des Nutzers (Pflichtfeld)

Action: Index

GET /users.json
Mit der Index Action kann eine Liste aller Nutzer in einem Account abgefragt werden. Durch Angabe des Parameters active wird die Abfrage auf die derzeit aktiven Nutzer beschränkt.

Beispiel
curl -X GET https://accountname.centralstationcrm.net/api/users.json

[
{"user":{"id":1781,"first":"Jolly","name":"Mäh","login":"jollysmail@42he.com"}},
...
]

Action: Search

GET /users/search.json?name=Mäh&first=Jolly
Um nach einer oder mehreren Nutzern zu suchen können die Parameter name und first übergeben werden. Der Parameter name ist Pflichtfeld, first muss nicht übergeben werden. Wenn ein oder mehrere Treffer gefunden wurden erfolgt die Rückgabe in gleicher Form, wie bei der Index Funktion. Wenn keine Treffer gefunden wurden geben wir einen leeren Array zurück.

Beispiel
curl -X GET https://accountname.centralstationcrm.net/api/users/search.json?name=Mäh

[{"user":{"id":1781,"first":"Jolly","name":"Mäh","login":"jollysmail@42he.com"}}]