# Search Use this module when you need to allow the user to search for items or simply return multiple items. ## Components ### Communication For additional information, see our [communication](/custom-apps-documentation/component-blocks/api.md) documentation. #### Pagination If API supports pagination, you can implement it by using the [pagination directive](/custom-apps-documentation/component-blocks/api/pagination.md). ### Static Parameters You can use [static parameters](/custom-apps-documentation/component-blocks/parameters.md) inside the search module without any restrictions. ### Mappable Parameters You can use [mappable parameters](/custom-apps-documentation/component-blocks/mappable-parameters.md) inside the search module without any restrictions. ### Interface Unlike the action module, the search module can [return multiple bundles at once](/custom-apps-documentation/component-blocks/interface.md). ### Samples To help the users with setting up your module, provide [samples](/custom-apps-documentation/component-blocks/samples.md). ### Scope When using an OAuth type of connection, use the [scope](/custom-apps-documentation/component-blocks/scope.md) to define scopes required by this module. ### Available IML variables These IML variables are available for you to use everywhere in this module:

Variable	Description
`now`	Current date and time
`environment`	TBD
`temp`	Contains custom variables created via the `temp` directive.
`parameters`	Contains the module’s input parameters.
`connection`	Contains the connection’s data collection.
`common`	Contains the app’s common data collection.
`data`	Contains the module’s data collection.
`scenario`	TBD
`metadata.expect`	Contains the module’s raw parameters array in the way you have specified it in the configuration.
`metadata.interface`	Contains module’s raw interface array in the way you have specified it in the configuration.

Additional variables available for the response object:

Variable	Description
`output`	When using the `wrapper` directive, the `output` variable represents the result of the `output`directive.
`limit`	When using a limit, the process of retrieving items will stop once the requested number of items has been obtained or if a page doesn't contain any items. Additionally, the module will return only the exact number of items that was specified.
`iterate`	Iterates the array in the response into items.

Additional variables available after using the `iterate` directive, i.e. in `wrapper` or `pagination` directives:

Variable	Description
`iterate.container.first`	Represents the first item of the array you iterated.
`iterate.container.last`	Represents the last item of the array you iterated.

Additional variables available for pagination and response objects:

Variable	Description
`body`	Contains the body that was retrieved from the last request.
`headers`	Contains the response headers that were retrieved from the last request.
`items`	When iterating this variable represents the current item that is being iterated.

## Example {% tabs %} {% tab title="Appearance" %}

{% endtab %} {% tab title="Communication" %} ```json { "url": "/api/users", "qs": { "search": "{{parameters.search}}" }, "method": "GET", "response": { "output": "{{item}}", "iterate": "{{body.users}}", "limit": "{{parameters.limit}}" } } ``` {% endtab %} {% tab title="Static parameters" %} ```json [] ``` {% endtab %} {% tab title="Mappable parameters" %} ```json [ { "name": "search", "type": "text", "label": "Search", "required": true }, { "name": "limit", "type": "uinteger", "label": "Limit", "help": "Maximum number of results to return and work with during one execution cycle.", "default": 10 } ] ``` {% endtab %} {% tab title="Interface" %} ```json [ { "name": "id", "type": "uinteger", "label": "User ID" }, { "name": "email", "type": "email", "label": "Email address" }, { "name": "name", "type": "text", "label": "Name" }, { "name": "created", "type": "date", "label": "Date created" } ] ``` {% endtab %} {% tab title="Samples" %} ```json { "id": 1, "email": "johndoe@email.com", "name": "John Doe", "created": "2018-01-01T12:00:00.000Z" } ``` {% endtab %} {% endtabs %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developers.make.com/custom-apps-documentation/app-components/modules/search.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.