Traversing objects in the Flow API

Tags: Flow

Requesting data from two related objects is usually not easy in rest requests. Normally, you have to make separate API calls to get the exact data you want. Flow makes traversing multiple, related objects a snap.

Who can use this?

 Core
Plus
 
   

 

For example. to request a list of users within a team whose name includes the word feedme, use the following request. Users and teams are the related objects, and you need 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 (opens email form) for 24/7 assistance.