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

# List all registered predicates

> **Required scope:** read

**Required scope:** `read`

### Query parameters

<ParamField query="limit" type="integer">
  Maximum number of items to return (1-1000, default: 50)
</ParamField>

<ParamField query="offset" type="integer">
  Number of items to skip (default: 0)
</ParamField>

<ParamField query="cursor" type="string">
  Cursor for cursor-based pagination (alternative to offset)
</ParamField>

<ParamField query="sort" type="string">
  Sort field with optional direction prefix (- for descending) Examples: 'created\_at', '-name', 'confidence'
</ParamField>

### Response

`ListPredicatesResponse`

<ResponseField name="predicates" type="PredicateResponse[]" required>
  <Expandable title="PredicateResponse">
    <ResponseField name="arg_types" type="string[]" required />

    <ResponseField name="arity" type="integer" required />

    <ResponseField name="doc" type="string" />

    <ResponseField name="name" type="string" required />

    <ResponseField name="return_type" type="string" />
  </Expandable>
</ResponseField>

<ResponseField name="total" type="integer" required />

### Status codes

| Code  | Meaning                                            |
| ----- | -------------------------------------------------- |
| `200` | List of predicates                                 |
| `401` | Unauthorized — missing or invalid credentials      |
| `403` | Forbidden — the key/token lacks the required scope |
| `429` | Rate limited — see Retry-After / X-RateLimit-Reset |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.nsr.stateset.com/api/v1/types/predicates' \
    --header 'X-API-Key: YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "predicates": [
      {
        "arg_types": [],
        "arity": 1,
        "doc": "string",
        "name": "Two-Person Tent",
        "return_type": "string"
      }
    ],
    "total": 102
  }
  ```
</ResponseExample>