Filter Gruppen 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

Filter Gruppen in CentralStationCRM sind dazu da, gefilterte Ergebnisse bei Personen, Firmen, Angeboten oder Projekten zu speichern und diese später erneut abzurufen. Über die API können die Elemente innerhalb einer Filter Gruppe aufgerufen werden.

Der Nutzer filtert eine Liste und speichert diese unter einem Namen ab. Die INDEX Funktion liefert die Namen und IDs aller im Account gespeicherten Gruppen zurück.

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

[
{"filter_group":{"id":288,"account_id":21,"model_type":"company","name":"agenturen",
"element_count":"2","created_at":"2013-10-31T07:27:27.000Z","updated_at":"2013-10-31T07:27:27.000Z"}},

{"filter_group":{"id":1063,"account_id":21,"model_type":"person","name":"Export nach NL2Go",
"element_count":"9","created_at":"2015-06-08T09:23:15.000Z","updated_at":"2015-06-08T09:23:15.000Z"}},

...
]
    

Über die SHOW Funktion lassen sich dann die Objekte in der üblichen Paginierung laden. Die Darstellung ist equivalent zu der der INDEX Funktionen der Objekte (z.B. Personen). Diese können Personen, Firmen, Angebote oder Projekte sein.

Die verschachtelten Objekte können über den includes Parameter angefordert werden, wie auch bei den index Funktionen der jeweiligen Objektart (z.B. includes=tels emails companies bei model_type person).

curl --user jolly.maeh@42he.com:password
-X GET https://demo.centralstationcrm.net/api/filter_groups/15.json&includes=addrs emails tels people

[
{"company":{"id":986,"account_id":21,"user_id":64,"name":"Barmedika","is_own":false,
"demo":false,"created_by_user_id":null,"created_at":"2010-10-30T19:28:51.000Z",
"updated_at":"2014-03-01T10:13:18.000Z","import_log_id":null,"background":null,
"responsible_user_natural_name":"Axel von Leitner",
"people":[
  {"id":4665,"account_id":21,"user_id":64,"own_user_id":null,"title":"Frau","gender":1,
  "first_name":"Susanne","name":"Meerheim","background":"","import_log_id":null,"demo":false,
  "created_by_user_id":64,"updated_by_user_id":64,
  "created_at":"2010-10-30T19:27:42.000Z","updated_at":"2015-04-15T11:35:02.000Z"}],
"addrs":[],
"emails":[],
"tels":[]}},

...
]