people-views
List people view relationships for user
Returns person-to-person relationships for a specific user within a people view using cursor-based pagination.
get/people-views/{peopleViewId}/users/{userId}/relationships
Request
- Base URLhttps://api.usecrouton.com
- Auth
- HTTP bearer
- or API key in header X-Api-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The people view identifier.
The user identifier.
Query parameters
Maximum number of items to return per page.
Opaque cursor from a previous page response.
Filter to relationships with a specific related user.
Filter by relationship direction.
Filter to relationships active on an ISO date.
Response
A page of relationships for the user.
Changes
No recorded changes to this operation across all 3 revisions of this API.