Get intent-rule fields context

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usefini.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get intent-rule fields context

> Get the fields and resources available to intent-rule trees.

Returns the workspace attributes, actions, tags, forms, operators, and sources that can be referenced by an intent-rule tree.

## Headers

<ParamField header="Authorization" type="string" required>
  Bearer token containing your Fini workspace API key. Format: `Bearer fini_...` The key needs `read` scope.
</ParamField>

## Response

<ResponseField name="userAttributes" type="FieldResource[]">
  Workspace user attributes with their input and output schemas.
</ResponseField>

<RequestExample>
  ~~~bash cURL theme={null}
  curl --request GET \
    --url 'https://api-prod.usefini.com/v2/hc-rules/fields-context/public' \
    --header 'Authorization: Bearer fini_your_api_key'
  ~~~

  ~~~javascript Node.js theme={null}
  const response = await fetch('https://api-prod.usefini.com/v2/hc-rules/fields-context/public', {
    method: 'GET',
    headers: {
      Authorization: 'Bearer fini_your_api_key'
    }
  });

  const data = await response.json();
  ~~~

  ~~~python Python theme={null}
  import requests

  response = requests.get(
      "https://api-prod.usefini.com/v2/hc-rules/fields-context/public",
      headers={"Authorization": "Bearer fini_your_api_key"},
  )

  data = response.json()
  ~~~
</RequestExample>

<ResponseExample>
  ~~~json 200 OK theme={null}
  {
    "contextFields": [
      {
        "path": "message.text",
        "dataType": "string"
      },
      {
        "path": "user.email",
        "dataType": "string"
      }
    ],
    "operatorTypes": [
      "==",
      "!=",
      "contains"
    ],
    "quantifierTypes": [
      "ANY",
      "ALL",
      "NONE"
    ]
  }
  ~~~
</ResponseExample>

<ResponseField name="actions" type="FieldResource[]">
  Workspace actions available to Tool nodes.
</ResponseField>

<ResponseField name="defaultActions" type="FieldResource[]">
  Fini-provided actions available to Tool nodes.
</ResponseField>

<ResponseField name="tagGroups" type="TagGroup[]">
  Input tag groups and their tags.
</ResponseField>

<ResponseField name="widgetForms" type="WidgetForm[]">
  Widget forms and their typed fields.
</ResponseField>

<ResponseField name="contextFields" type="ContextField[]">
  Empty for intent rules.
</ResponseField>

<ResponseField name="operatorTypes" type="Operator[]">
  Condition operators as `{ value, label }` objects.
</ResponseField>

<ResponseField name="quantifierTypes" type="Quantifier[]">
  Array quantifiers as `{ value, label }` objects.
</ResponseField>

<ResponseField name="sources" type="string[]">
  Interaction sources available in the workspace.
</ResponseField>

## Errors

<AccordionGroup>
  <Accordion title="400 Bad Request" icon="circle-exclamation">
    `type` is not a supported rule type.
  </Accordion>

  <Accordion title="401 Unauthorized" icon="lock">
    The API key is missing, malformed, revoked, or invalid.
  </Accordion>

  <Accordion title="403 Forbidden" icon="shield-halved">
    The API key does not include the `read` scope required for this route.
  </Accordion>
</AccordionGroup>


## Related topics

- [Get intent rule](/en/api-reference/get-intent-rule.md)
- [Overview](/en/api-reference/intent-rules.md)
- [Get intent-rule version](/en/api-reference/get-rule-version.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.