GET/admin/v1/flows

List flows

Lists 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.

    Supports:

    • createTime desc
  • view

    enum

    The Flow view to return in the results.

    This defaults to the BASIC view.

    Possible values:
    BASICFULL

Returns

  • flows

    Flow[]

    The list of flows.

  • 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.

curl https://api.userhub.com/admin/v1/flows \
  -H "Authorization: Bearer $ADMIN_API_KEY"
Response bodyJSON
{
  "flows": [
    {
      "id": "flow_2VSCZXUfZVeRY3",
      "state": "START_PENDING",
      "type": "SIGNUP",
      "organization": null,
      "user": null,
      "creator": null,
      "startTime": null,
      "expireTime": "2024-06-15T13:00:00Z",
      "createTime": "2024-06-15T13:00:00Z",
      "updateTime": "2024-06-15T13:00:00Z"
    },
    {
      "id": "flow_3on5rHNG5aMGao",
      "state": "START_PENDING",
      "type": "JOIN_ORGANIZATION",
      "organization": null,
      "user": null,
      "creator": null,
      "startTime": null,
      "expireTime": "2024-06-15T13:00:00Z",
      "createTime": "2024-06-15T13:00:00Z",
      "updateTime": "2024-06-15T13:00:00Z"
    }
  ],
  "nextPageToken": ""
}
PreviousThe flow object
NextSend a join organization invitation

Turn users intorevenue
$

Subscribe to monthly product updates

© 2024 UserHub

Integrations

    UserHub & Auth0UserHub & Stripe BillingUserHub & Google CloudUserHub & FirebaseUserHub & custom auth