> For the complete documentation index, see [llms.txt](https://docs.opensoutheners.com/oss/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opensoutheners.com/oss/flex-url/building-urls/search.md).

# Search

Build q= full-text search and q\[filter]\[]= search-scoped filter query parameters.

`search(term)` sets the top-level `q=term`, apiable's full-text search parameter (Laravel Scout integration). `searchFilter(attribute, values)` narrows a search within `q[filter][attribute]=`.

{% tabs %}
{% tab title="TypeScript" %}

```ts
flexUrl('/posts').search('laravel');
// /posts?q=laravel

flexUrl('/posts').search('laravel').searchFilter('status', 'published');
// /posts?q=laravel&q[filter][status]=published
```

{% endtab %}

{% tab title="PHP" %}

```php
FlexUrl::make('/posts')->search('laravel');
// /posts?q=laravel

FlexUrl::make('/posts')->search('laravel')->searchFilter('status', 'published');
// /posts?q=laravel&q[filter][status]=published
```

{% endtab %}
{% endtabs %}

## `whereIn()` semantics for multiple values

A single value uses the plain key. **Multiple** values use apiable's repeated-`[]` `whereIn()` convention rather than the comma list used elsewhere in the grammar — this differs from `filter()`/`sort()`/`include()` deliberately, because apiable's own search-filter parsing expects it:

{% tabs %}
{% tab title="TypeScript" %}

```ts
flexUrl('/posts').search('laravel').searchFilter('status', ['published', 'draft']).toString();
// /posts?q=laravel&q[filter][status][]=published&q[filter][status][]=draft
```

{% endtab %}

{% tab title="PHP" %}

```php
FlexUrl::make('/posts')->search('laravel')->searchFilter('status', ['published', 'draft'])->toString();
// /posts?q=laravel&q[filter][status][]=published&q[filter][status][]=draft
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
An explicit `[]` on the wire stays a list even with a single value: parsing `q[filter][status][]=published` back reports `["published"]`, not `"published"` — the `[]` suffix itself is the signal, not the value count.
{% endhint %}

## Reading search back

{% tabs %}
{% tab title="TypeScript" %}

```ts
const parsed = flexUrl('/posts?q=laravel&q[filter][status]=published');

parsed.getSearch();               // "laravel"
parsed.getSearchFilter('status'); // "published"
```

{% endtab %}

{% tab title="PHP" %}

```php
$parsed = FlexUrl::from('/posts?q=laravel&q[filter][status]=published');

$parsed->getSearch();               // "laravel"
$parsed->getSearchFilter('status'); // "published"
```

{% endtab %}
{% endtabs %}

Because `q` is a scalar param, a comma inside a search term stays literal — it is not split into several values the way `filter`/`sort`/`include`/`fields`/`appends` are. See [Encoding Contract](https://docs.opensoutheners.com/oss/flex-url/advanced/encoding-contract.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.opensoutheners.com/oss/flex-url/building-urls/search.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
