Traversing objects

Tags: Flow

Overview

Requesting data from two related objects is usually no easy feat in REST requests. You normally have to make separate API calls to get the exact data you want. Flow makes traversing (i.e. passing through) multiple, related objects a snap.  

For example, to request a list of users that are within a team whose name includes the word “feedme.” USERS and TEAMS are the related objects, and you would normally have to make multiple calls, first searching for all TEAMS with “The A Team”, then searching for all USERS in those teams.  

Object traversal uses the double underscore syntax.

Request:

https://flow.pluralsight.com/v3/customer/core/users/?team__name=feedme
Response:

Traversable objects are indicated in the object definitions with "filter-traversable object.

back to top


If you need help, please email support@pluralsight.com for 24/7 assistance.