---
title: "get params · RUAL Documentation"
description: "Returns all params if present, params are optional or required parameters in API URIs, for example :name."
canonical: https://docs.rual.nl/block-types/http%20connection/httpconnection_get_params
language: en
---

[Cluster](https://docs.rual.nl/cluster)

[Blocks](https://docs.rual.nl/block-types)

[Interfaces](https://docs.rual.nl/interfaces)

[Blueprints](https://docs.rual.nl/blueprints)

[Tutorials](https://docs.rual.nl/tutorials)

[Home automation](https://docs.rual.nl/home-automation)

[Examples](https://docs.rual.nl/examples)

[Reference](https://docs.rual.nl/reference)

[Architecture](https://docs.rual.nl/architecture)

[Troubleshooting](https://docs.rual.nl/troubleshooting)

Other

# get params

This block is part of the [`http connection`](https://docs.rual.nl/block-types/http%20connection) group and was last modified in core [`v10.4.28`](https://docs.rual.nl/core-versions/100428).

Returns all params if present, params are optional or required parameters in API URIs, for example `:name`.

- connection required `httpconnection`

- params `object`

Outputs the URL path parameters of the matched route as an object, e.g. route customers/:id with /customers/42 -> {id: "42"}. When the connection pin is unwired it falls back to the params seeded on the currently running function; emits nil when there are no params.

A typical wiring for [get params](https://docs.rual.nl/block-types/http%2520connection/httpconnection_get_params): [current request](https://docs.rual.nl/block-types/http%2520connection/httpconnection_current_request) feeds the `connection` pin; the `params` out pin feeds [get fields](https://docs.rual.nl/block-types/object/object_field_getter_multiple).

[![Studio canvas example for the get params block: typical wiring for get params.](https://docs.rual.nl/canvas-examples/httpconnection_get_params.png)](https://docs.rual.nl/canvas-examples/httpconnection_get_params.png?v=3)

## Commonly used with

In production blueprints, this block is most often wired together with:

- [current request](https://docs.rual.nl/block-types/http%20connection/httpconnection_current_request): feeds into this block. Retrieves a reference to the current HTTP Connection.

- [get fields](https://docs.rual.nl/block-types/object/object_field_getter_multiple): this block feeds into it. Gets the selected fields from the given object.

## Used in these guides

These documentation pages use or explain this block:

- [Creating a REST API](https://docs.rual.nl/tutorials/rest-api)

- [Common Blueprint Patterns](https://docs.rual.nl/blueprints/common-patterns)

- [Block Quick Reference](https://docs.rual.nl/reference/block-quick-reference)

- [Build Your First API](https://docs.rual.nl/cluster/api-quickstart)

## Version history

Introduced in [`v10.4.28`](https://docs.rual.nl/core-versions/100428).

- [Back to `http connection`](https://docs.rual.nl/block-types/http%20connection): Return to the main group to view all sub-groups

- [Back to `http`](https://docs.rual.nl/block-types/http%20connection?group=http): Return to the group to view all blocks within this group

Was this page helpful? [Tell us what to improve](https://docs.rual.nl/support) · RUAL Docs is an integral component of the [RUAL ecosystem](https://rual.nl)