Skip to main content
POST
/
graphql#ListHhdFlows
List HHD flows
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListHhdFlows' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: RfFlowFilterType) { rf_flows { all(filter: $filter) { edges { node { id code name flow_type is_default slug implementation_id created_at } } } } }"
}
'
{
  "data": {
    "rf_flows": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "code": "PICK_STANDARD",
              "name": "Standard Pick Flow",
              "flow_type": "standard",
              "is_default": false,
              "slug": "pick-standard",
              "implementation_id": "1",
              "created_at": "2026-01-10T12:00:00Z"
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: RfFlowFilterType) {
  rf_flows {
    all(filter: $filter) {
      edges {
        node {
          id
          code
          name
          flow_type
          is_default
          slug
          implementation_id
          created_at
        }
      }
    }
  }
}
Note: HHD flows are exposed under the rf_flows GraphQL field and RfFlowFilterType filter type.

​
Filter Argument

All filters are passed inside the filter argument. Each field accepts an input object with operators.

​
Available Filters

FilterInput TypeOperatorsDescription
codeStringInputTypeeq, ilike, like, in, betweenFlow code
nameStringInputTypeeq, ilike, like, in, betweenFlow name
flow_typeFlowTypeInputTypeeqstandard, task, or loading
implementation_idIdInputTypeeq, in, filledHHD implementation
implementation_codeStringInputTypeeq, ilike, like, in, betweenHHD implementation code
is_defaultBooleanInputTypeeqDefault flow status
slugStringInputTypeeq, ilike, like, in, betweenFlow slug
More fields and filters available via GraphQL introspection.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
​
query
string<textarea>
required

GraphQL query string

Example:

"query($filter: RfFlowFilterType) { rf_flows { all(filter: $filter) { edges { node { id code name flow_type is_default slug implementation_id created_at } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "flow_type": { "eq": "standard" } }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any