← Tools Reference

Userflow

Userflow integration (Data, Marketing). Imported from open-connector.

API key8 toolshttps://api.userflow.com
GET
userflow_list_users
List Userflow users with optional cursor pagination and filters.

/users

7 parameters
ParamTypeRequiredDescription
limitintegeroptionalMaximum number of items to return.
starting_afterstringoptionalObject ID after which the page should start.
ending_beforestringoptionalObject ID before which the page should end.
emailstringoptionalFilter users by email address.
user_idstringoptionalFilter users by external user ID.
expandarrayoptionalExpandable Userflow fields to include in the response.
order_bystringoptionalSort order accepted by Userflow.
GET
userflow_get_user
Fetch one Userflow user by ID.

/users/{user_id}

2 parameters
ParamTypeRequiredDescription
user_idstringrequiredThe Userflow user ID to retrieve.
expandarrayoptionalExpandable Userflow fields to include in the response.
POST
userflow_upsert_user
Create or update one Userflow user.

/users

6 parameters
ParamTypeRequiredDescription
user_idstringrequiredThe external user ID to create or update in Userflow.
namestringoptionalThe user's display name.
emailstringoptionalThe user's email address.
signed_up_atstringoptionalTimestamp when the user signed up.
attributesobjectoptionalUserflow custom attributes keyed by attribute name.
groupsarrayoptionalGroup IDs the user belongs to.
DELETE
userflow_delete_user
Delete one Userflow user by ID.

/users/{user_id}

1 parameter
ParamTypeRequiredDescription
user_idstringrequiredThe Userflow user ID to delete.
POST
userflow_upsert_group
Create or update one Userflow group.

/groups

3 parameters
ParamTypeRequiredDescription
group_idstringrequiredThe external group ID to create or update in Userflow.
namestringoptionalThe group's display name.
attributesobjectoptionalUserflow custom attributes keyed by attribute name.
GET
userflow_get_group
Fetch one Userflow group by ID.

/groups/{group_id}

2 parameters
ParamTypeRequiredDescription
group_idstringrequiredThe Userflow group ID to retrieve.
expandarrayoptionalExpandable Userflow fields to include in the response.
DELETE
userflow_delete_group
Delete one Userflow group by ID.

/groups/{group_id}

1 parameter
ParamTypeRequiredDescription
group_idstringrequiredThe Userflow group ID to delete.
POST
userflow_track_event
Track one Userflow event for a user.

/events

5 parameters
ParamTypeRequiredDescription
namestringrequiredThe event name to track.
user_idstringrequiredThe Userflow user ID associated with the event.
group_idstringoptionalThe Userflow group ID associated with the event.
occurred_atstringoptionalTimestamp when the event occurred.
attributesobjectoptionalUserflow custom attributes keyed by attribute name.