Auth0 API | Flows › Get Flows

Flows

flows

Methods

Create A Flow -> { id, created_at, name, 3 more... }

post/flows

Create a flow

Delete A Flow ->

delete/flows/{id}

Delete a flow

Get Flows -> FlowsPageNumberPage<{ id, created_at, name, 2 more... }>

get/flows

Get flows

Security

Example: Authorization: Bearer My Bearer Token

Parameters

hydrate: Array<

Optional

hydration param

"form_count"

include_totals: boolean

Optional

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

page: number

Optional

(maximum: 1000, minimum: 0)

Page index of the results to return. First page is 0.

per_page: number

Optional

(maximum: 100, minimum: 1)

Number of results per page. Defaults to 50.

synchronous: boolean

Optional

flag to filter by sync/async flows

Response fields

UnionMember0 = Array<{ id, created_at, name, 2 more... }>

UnionMember1 = { flows, limit, start, 1 more... }

Request example

curl https://login0.local.dev.auth0.com/api/v2/flows \
    -H "Authorization: Bearer $BEARER_TOKEN"

200Example

[
  {
    "id": "id",
    "created_at": "2019-12-27T18:11:19.117Z",
    "name": "x",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "executed_at": "2019-12-27"
  }
]

Get A Flow ->

Flow

get/flows/{id}

Get a flow

Update A Flow -> { id, created_at, name, 3 more... }

patch/flows/{id}

Update a flow

Domain types

Flow = { id, created_at, name, 3 more... }

Flows

Executions

flows.executions

Methods

Delete A Flow Execution ->

delete/flows/{flow_id}/executions/{execution_id}

Delete a flow execution

Get Flow Executions -> FlowsExecutionsPageNumberPage<{ id, created_at, status, 5 more... }>

get/flows/{flow_id}/executions

Get flow executions

Get A Flow Execution ->

FlowExecution

get/flows/{flow_id}/executions/{execution_id}

Get a flow execution

Domain types

FlowExecution = { id, created_at, status, 6 more... }

Flows

Vault Connections

flows.vault_connections

Methods

Delete A Flows Vault Connection ->

delete/flows/vault/connections/{id}

Delete a Flows Vault connection

Get A Flows Vault Connection ->

VaultConnection

get/flows/vault/connections/{id}

Get a Flows Vault connection

Update A Flows Vault Connection -> { id, app_id, created_at, 7 more... }

patch/flows/vault/connections/{id}

Update a Flows Vault connection

Domain types

VaultConnection = { id, app_id, created_at, 7 more... }