List flows

GET/admin/v1/flows

List flows.

query parameters

organizationId
string
Filter results by organization identifier.
userId
string
Filter results by user identifier.
type
string
Filter the results by the specified flow type.
active
boolean
Whether to filter out flows not in the START_PENDING or STARTED state.
creatorUserId
string
The identifier of the user that created the flow.
When this is specified only the flows created by the user are returned.
pageSize
int32
The maximum number of flows to return. The API may return fewer than this value.
If unspecified, at most 20 flows will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken
string
A page token, received from a previous list flows call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to list flows must match the call that provided the page token.
orderBy
string
A comma-separated list of fields to order by.
view
enum
The Flow view to return in the results.
This defaults to the BASIC view.
Possible values:
BASICFULL

Returns

flows
Flow[]
BASIC
The list of flows.
id
string
The system-assigned identifier of the flow.
state
enum
The current state of the flow.
Possible values:
START_PENDINGSTARTEDCOMPLETEDCANCELEDEXPIRED
stateReason
string
The code that best describes the reason for the state.
type
enum
The flow type.
Possible values:
JOIN_ORGANIZATIONSIGNUP
startTime
date-time
The start time of the flow.
expireTime
date-time
The time the flow will expire.
ttl
string
The expire duration of the flow.
view
enum
The flow view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the flow.
updateTime
date-time
The last update time of the flow.
nextPageToken
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
previousPageToken
string
A token, which can be sent as pageToken to retrieve the previous page. If this field is absent, there are no preceding pages. If this field is an empty string then the previous page is the first result.

code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.

curl https://api.userhub.com/admin/v1/flows \
  -H "Authorization: Bearer $USERHUB_ADMIN_KEY"

const res = await adminApi.flows.list();

res, err := adminApi.Flows().List(
    context.Background(),
    nil,
)

$res = $adminApi->flows->list();

res = admin_api.flows.list()

Response bodyJSON

{
  "flows": [
    {
      "id": "flow_2VSCZXUfZVeRY3",
      "state": "START_PENDING",
      "type": "SIGNUP",
      "expireTime": "2025-05-15T13:00:00Z",
      "signup": {
        "email": "[email protected]"
      },
      "view": "BASIC",
      "createTime": "2025-05-15T13:00:00Z",
      "updateTime": "2025-05-15T13:00:00Z"
    },
    {
      "id": "flow_3on5rHNG5aMGao",
      "state": "START_PENDING",
      "type": "JOIN_ORGANIZATION",
      "expireTime": "2025-05-15T13:00:00Z",
      "joinOrganization": {},
      "view": "BASIC",
      "createTime": "2025-05-15T13:00:00Z",
      "updateTime": "2025-05-15T13:00:00Z"
    }
  ]
}

PreviousThe flow object

NextSend a join organization invitation

List flows

.css-10iahqc{text-transform:capitalize;}query parameters

Returns

query parameters