GET/user/v1/flows

List flows

Lists flows.

query parameters

organizationId
string
The identifier of the organization.
When not set the user's flows are returned.
Otherwise if the user is an admin of the provided organization then the flows associated with that organization are returned.
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.
creator
boolean
Whether to only return flows created by the authenticated user.
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.
Supports:
- createTime desc

Returns

flows
Flow[]
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
organization
Organization
The target organization for the flow.
id
string
The system-assigned identifier of the organization.
uniqueId
string
The client defined unique identifier of the organization account.
displayName
string
The human-readable display name of the organization.
email
string
The email address of the organization.
emailVerified
boolean
Whether the organization's email address has been verified.
imageUrl
string
The photo/avatar URL of the organization.
memberCount
int32
The number of members in the organization.
This includes disabled users, but does not include user's marked for deletion.
disabled
boolean
Whether the organization is disabled.
user
User
The target user for the flow.
id
string
The system-assigned identifier of the user.
uniqueId
string
The client defined unique identifier of the user account.
displayName
string
The human-readable display name of the user.
email
string
The email address of the user.
emailVerified
boolean
Whether the user's email address has been verified.
imageUrl
string
The photo/avatar URL of the user.
disabled
boolean
Whether the user is disabled.
creator
User
The user who created the flow.
id
string
The system-assigned identifier of the user.
uniqueId
string
The client defined unique identifier of the user account.
displayName
string
The human-readable display name of the user.
email
string
The email address of the user.
emailVerified
boolean
Whether the user's email address has been verified.
imageUrl
string
The photo/avatar URL of the user.
disabled
boolean
Whether the user is disabled.
expireTime
date-time
The time the flow will expire.
createTime
date-time
The creation time of the flow.
joinOrganization
JoinOrganizationFlow
The join organization flow type specific data.
displayName
string
The display name of the invitee.
email
string
The email address of the invitee.
This is required if a user isn't provided or the user's email address is empty.
role
Role
The role to be assigned to the invitee.
id
string
The system-assigned identifier of the role.
uniqueId
string
The client defined unique identifier of the role.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with role_ are reserved.
displayName
string
The human-readable display name of the role.
type
enum
The role type.
Possible values:
OWNERMEMBERGUEST
description
string
The description of the role.
The maximum length is 1000 characters.
permissionSets
string[]
The additional permissions allowed by the role.
default
boolean
Whether the role is the default for the tenant.
signup
SignupFlow
The signup flow type specific data.
email
string
The email address of the invitee.
displayName
string
The display name of the invitee.
createOrganization
boolean
Whether to create an organization as part of the signup 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.

curl https://api.userhub.com/user/v1/flows \
  -H "UserHub-Api-Key: $USER_API_KEY" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN"

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

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

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

res = user_api.flows.list()

Response bodyJSON

{
  "flows": [
    {
      "id": "flow_3on5rHNG5aMGao",
      "state": "START_PENDING",
      "type": "JOIN_ORGANIZATION",
      "organization": {
        "id": "org_28seyVGVL1got6",
        "displayName": "Acme Inc",
        "email": "[email protected]",
        "emailVerified": true,
        "imageUrl": "https://example.com/acme.jpg",
        "memberCount": 0
      },
      "user": {
        "id": "usr_MKFxzgJaAH8JQ4",
        "displayName": "Jane Doe",
        "email": "[email protected]",
        "emailVerified": true,
        "imageUrl": "https://example.com/jane.jpg"
      },
      "creator": {
        "id": "usr_EHTXpuz9rs8TCU",
        "displayName": "John Doe",
        "email": "[email protected]",
        "emailVerified": false,
        "imageUrl": "https://example.com/john.jpg"
      },
      "expireTime": "2024-06-15T13:00:00Z",
      "createTime": "2024-06-15T13:00:00Z"
    }
  ],
  "nextPageToken": ""
}

PreviousThe flow object

NextSend a join organization invitation

List flows

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

Returns

query parameters