req.param()
Returns the value of the parameter with the specified name.
Usage
req.param(name[, defaultValue]);
Details
req.param() searches the URL path, body, and query string of the request (in that order) for the specified parameter. If no parameter value exists anywhere in the request with the given name, it returns undefined or the optional defaultValue if specified.
- URL path parameters (
req.params)- e.g. a request "/foo/4" to route
/foo/:idhas URL path params{ id: 4 }
- e.g. a request "/foo/4" to route
- body parameters (
req.body)- e.g. a request with a parseable body (e.g. JSON, URL-encoded, or XML) has body parameters equal to its parsed value
- query string parameters (
req.query)- e.g. a request "/foo?email=5" has query params
{ email: 5 }
- e.g. a request "/foo?email=5" has query params
Example
Consider a route (POST /product/:sku) that points to a custom action or policy that has the following code:
req.param('sku');
// -> 123
We can get the expected result by sending the sku parameter any of the following ways:
POST /product/123POST /product?sku=123POST /product- with a JSON request body:
{ "sku": 123 }
- with a JSON request body:
Notes
- The order of precedence means that URL path params will override request body params, which will override query string params.
- If you'd like to get ALL parameters from ALL sources (including the URL path, query string, and parsed request body) you can use
req.allParams().
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command-line interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
Reference
Built with Love
The Sails framework is built by a web & mobile shop in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!
© 2012-2025 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.